2.4.36 FileQuotaInformation
This information class is used to query or to set file quota information for a volume. For queries, an optional buffer of FILE_GET_QUOTA_INFORMATION (section 2.4.36.1) data elements is provided by the client to specify the SIDs for which quota information is requested. If the FILE_GET_QUOTA_INFORMATION buffer is not specified, information for all quotas is returned. A buffer of FILE_QUOTA_INFORMATION data elements is returned by the server. For sets, FILE_QUOTA_INFORMATION data elements are populated and sent by the client, as specified in [MS-SMB] section 2.2.7.6.1 and [MS-SMB2] section 3.2.4.15.<131>
When multiple FILE_QUOTA_INFORMATION data elements are present in the buffer, each MUST be aligned on an 8-byte boundary. Any bytes inserted for alignment SHOULD be set to zero, and the receiver MUST ignore them. No padding is required following the last data element.
A FILE_QUOTA_INFORMATION data element is as follows.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
NextEntryOffset |
|||||||||||||||||||||||||||||||
|
SidLength |
|||||||||||||||||||||||||||||||
|
ChangeTime |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
QuotaUsed |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
QuotaThreshold |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
QuotaLimit |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
Sid (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
NextEntryOffset (4 bytes): A 32-bit unsigned integer that contains the byte offset from the beginning of this entry, at which the next FILE_QUOTA_INFORMATION entry is located, if multiple entries are present in a buffer. This member MUST be zero if no other entries follow this one. An implementation MUST use this value to determine the location of the next entry (if multiple entries are present in a buffer).
SidLength (4 bytes): A 32-bit unsigned integer that contains the length, in bytes, of the Sid data element.
ChangeTime (8 bytes): The last time that the quota was changed; see section 2.1.1. This value MUST be greater than or equal to 0x0000000000000000. When setting quota information, the server MUST ignore the value of this field.
QuotaUsed (8 bytes): A 64-bit signed integer that contains the amount of quota used by this user, in bytes. This value MUST be greater than or equal to 0x0000000000000000. When setting quota information, the server MUST ignore the value of this field.
QuotaThreshold (8 bytes): A 64-bit signed integer that contains the disk quota warning threshold, in bytes, on this volume for this user. This field MUST be set to a 64-bit integer value greater than or equal to 0 to set a quota warning threshold for this user on this volume. If this field is set to -1 there is no quota warning threshold for this user.
QuotaLimit (8 bytes): A 64-bit signed integer that contains the disk quota limit, in bytes, on this volume for this user. This field MUST be set to a 64-bit integer value greater than or equal to zero to set a disk quota limit for this user on this volume, to -1 to specify that no quota limit is set for this user, or to -2 to delete the quota entry for the user.
Sid (variable): Security identifier (SID) for this user.
This operation returns a status code as specified in section 2.2. Upon success, the status code returned by the function that processes this file information class is STATUS_SUCCESS. The most common error codes are listed in the following table.
|
Error code |
Meaning |
|---|---|
|
STATUS_INVALID_DEVICE_REQUEST 0xC0000010 |
The target file system does not implement this functionality. |
|
STATUS_INVALID_INFO_CLASS 0xC0000003 |
The specified information class is not a valid information class for the specified object. |
|
STATUS_INFO_LENGTH_MISMATCH 0xC0000004 |
The specified information record length does not match the length that is required for the specified information class. |
|
STATUS_INVALID_PARAMETER 0xC000000D |
The SID or SID Length specified is not a valid parameter. |
|
STATUS_NO_SUCH_FILE 0xC000000F |
For query operations, indicates that no FILE_QUOTA_INFORMATION data elements were returned that matched the input criteria. |
|
STATUS_BUFFER_TOO_SMALL 0xC0000023 |
The buffer is too small to contain the entry. No information has been written to the buffer. |