IDiskQuotaControl::CreateEnumUsers method (dskquota.h)

  • Article

Creates an enumerator object for enumerating quota users on the volume. The newly created object implements the IEnumDiskQuotaUsers interface.

Syntax

HRESULT CreateEnumUsers(
  [in]  PSID                  *rgpUserSids,
  [in]  DWORD                 cpSids,
  [in]  DWORD                 fNameResolution,
  [out] PENUM_DISKQUOTA_USERS *ppEnum
);

Parameters

[in] rgpUserSids

An array of security identifier (SID) pointers representing the user objects to be included in the enumeration. If this value is NULL, all user entries are enumerated.

[in] cpSids

The number of items in the rgpUserSids array. Ignored if rgpUserSids is NULL.

[in] fNameResolution

Indicates how the user account information is to be obtained. The volume's quota information identifies users by SID. The user account information (such as domain name, account name, and full name) must be obtained from the network domain controller, or the local computer if it is not on a network. This parameter can be one of the following values.

Value Meaning
DISKQUOTA_USERNAME_RESOLVE_ASYNC
2
 Resolve user account information asynchronously. The IEnumDiskQuotaUsers::Next method returns immediately. The caller must implement the IDiskQuotaEvents interface to receive notification when the information is available. If the information was cached during a previous request, notification occurs as soon as the object is serviced. Otherwise, the method obtains the information from the network domain controller, then notifies IDiskQuotaEvents.
DISKQUOTA_USERNAME_RESOLVE_NONE
0
 Do not resolve user account information.
DISKQUOTA_USERNAME_RESOLVE_SYNC
1
 Resolve user account information synchronously. The IEnumDiskQuotaUsers::Next method returns when the information is resolved. If the information exists in the disk quota SID cache, it is returned immediately. Otherwise, the method must locate the information. This can take several seconds.

[out] ppEnum

A pointer to a pointer to the IEnumDiskQuotaUsers enumerator.

Return value

This method returns one of the following values.

Return code Description
S_OK
 Success.
ERROR_ACCESS_DENIED
 The caller has insufficient access rights.
ERROR_NOT_READY
 The DiskQuotaControl object is not initialized.
E_INVALIDARG
 The ppEnum parameter is NULL.
E_OUTOFMEMORY
 Insufficient memory.
E_UNEXPECTED
 An unexpected exception occurred.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header dskquota.h
DLL Dskquota.dll

See also

Disk Management Interfaces

Disk Quotas

IDiskQuotaControl