Platform SDK: Files and I/O

IDiskQuotaControl::AddUserSid

Adds a new quota entry on the volume for the specified user. The user is identified by security identifier (SID).

HRESULT AddUserSid(
  PSID pUserSid, 
  DWORD fNameResolution,
  PDISKQUOTA_USER *ppUser
);

Parameters

pUserSid

Pointer to a buffer containing the user's SID.

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_NONE	Do not resolve user account information.
DISKQUOTA_USERNAME_RESOLVE_SYNC	Resolve user account information synchronously. AddUserSid 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.
DISKQUOTA_USERNAME_RESOLVE_ASYNC	Resolve user account information asynchronously. AddUserSid 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.

ppUser

Pointer to receive the IDiskQuotaUser interface pointer to the newly created quota user object.

Return Values

This method returns a file system error or one of the following values.

Value	Meaning
NOERROR	Success.
ERROR_ACCESS_DENIED	The caller has insufficient access rights.
ERROR_INVALID_SID	The specified SDI is unknown.
ERROR_NOT_READY	The DiskQuotaControl object is not initialized.
E_INVALIDARG	The pUserSid or ppUser parameter is NULL.
E_OUTOFMEMORY	Insufficient memory.
E_FAIL	An unexpected file system error occurred.
E_UNEXPECTED	An unexpected exception occurred.

Remarks

The NTFS file system automatically creates a user quota entry when a user first writes to the volume. Entries that are created automatically are assigned the default warning threshold and hard quota limit values for the volume. This method allows you to create a user quota entry before a user has written information to the volume. Therefore, you can pre-assign a warning threshold or hard quota limit value different than the volume default settings.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Dskquota.h.

IDiskQuotaControl::AddUserSid

Parameters

Return Values

Remarks

Requirements

See Also