IDiskQuotaControl::AddUserName method (dskquota.h)

Article
10/13/2021

Adds a new quota entry on the volume for the specified user. The user is identified by domain and account name.

Syntax

HRESULT AddUserName(
  [in]  LPCWSTR         pszLogonName,
  [in]  DWORD           fNameResolution,
  [out] PDISKQUOTA_USER *ppUser
);

Parameters

[in] pszLogonName

The user's account logon name string.

[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 container, logon name, and display 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. AddUserName 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. AddUserName 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] ppUser

A pointer to the IDiskQuotaUser interface pointer to the newly created quota user object.

Return value

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

Return code	Description
S_OK	Success.
S_FALSE	User already exists. Not added.
ERROR_NOT_READY	The DiskQuotaControl object is not initialized.
ERROR_USER_UNKNOWN	The specified user name is unknown.
E_INVALIDARG	A pointer 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

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