Export (0) Print
Expand All

DIDiskQuotaUser object

Allows a client to manage an NTFS volume's global disk quota settings. This object makes the essential functionality of the DIDiskQuotaUser interface available to scripting and Microsoft Visual Basic-based applications.

Members

The DIDiskQuotaUser object has these types of members:

Methods

The DIDiskQuotaUser object has these methods.

MethodDescription
Invalidate

Clears the object's cached user information.

 

Properties

The DIDiskQuotaUser object has these properties.

PropertyAccess typeDescription

AccountContainerName

Read-only

Gets the name of the user's account container.

AccountStatus

Read-only

Gets the status of the user's account.

DisplayName

Read-only

Gets the user's display name.

ID

Read-only

Gets an ID that uniquely identifies the user.

LogonName

Read-only

Gets the user's logon account name.

QuotaLimit

Read/write

Sets or gets the user's current quota limit.

QuotaLimitText

Read-only

Gets the user's current quota limit as a text string.

QuotaThreshold

Read/write

Sets or gets the user's warning threshold, in bytes.

QuotaThresholdText

Read-only

Gets the user's warning threshold as a text string.

QuotaUsed

Read-only

Gets the user's current disk usage, in bytes.

QuotaUsedText

Read-only

Gets the user's current disk usage as a text string.

 

Remarks

Each user on the volume that is managed by the DiskQuotaControl object has a DIDiskQuotaUser object associated with it. This object allows a client to manage an individual user's settings. There are several ways to obtain a user's DIDiskQuotaUser object:

  • The DIDiskQuotaUser objects for all users with quotas on the volume are exposed as a collection and can be enumerated. A discussion of how to enumerate DIDiskQuotaUser objects is found below.
  • When you add a new user, the AddUser method returns the user's DIDiskQuotaUser object.
  • If you have the user's name, the FindUser method returns the user's DIDiskQuotaUser object.

Enumerating Disk Quota Users

The DIDiskQuotaUser objects for all users with a quota on the volume are exposed as a collection. The DiskQuotaControl object exports a standard enumerator method that allows you to enumerate the collection of DIDiskQuotaUser objects. The following procedure illustrates how to perform the enumeration with Microsoft JScript (compatible with ECMA 262 language specification). You can use a similar procedure with Visual Basic or Microsoft Visual Basic Scripting Edition (VBScript).

  1. Create a new DiskQuotaControl object.
  2. Initialize it with Initialize.
  3. Create a new JScript Enumerator object.
  4. Use a for loop to enumerate the DIDiskQuotaUser objects. There is no need to set a starting value. The enumerator object's moveNext method notifies the item method to return the next DIDiskQuotaUser object. The atEnd method returns false when you reach the end of the list.
  5. As needed, use the DIDiskQuotaUser object returned by the enumerator's item method to retrieve or set one or more of the associated user's disk quota properties.

The following code fragment illustrates how to enumerate DIDiskQuotaUser objects with JScript. The Volume_Label argument that is passed to the EnumUsers function is a string value containing a volume label such as "C:\\".


function EnumUsers(Volume_Label)
{
    var Volume;
    var QuotaUsers;
    var QuotaUser;

    Volume = new ActiveXObject("Microsoft.DiskQuota.1");
    Volume.Initialize(Volume_Label, 1);

    QuotaUsers = new Enumerator(Volume);
    for (;!Users.atEnd(); Users.moveNext())
    {
       QuotaUser = QuotaUsers.item();

     //Use the QuotaUser object to retrieve or set one or more
     //of the user's disk quota properties
     ...
    }
}

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

DLL

Shell32.dll (version 5.0 or later)

See also

Shell Object

 

 

Community Additions

ADD
Show:
© 2014 Microsoft