NtQueryQuotaInformationFile 函数 (ntifs.h)

项目
03/05/2024

NtQueryQuotaInformationFile 例程检索与 FileHandle 参数指定的卷关联的配额条目。

语法

__kernel_entry NTSYSCALLAPI NTSTATUS NtQueryQuotaInformationFile(
  [in]           HANDLE           FileHandle,
  [out]          PIO_STATUS_BLOCK IoStatusBlock,
  [out]          PVOID            Buffer,
  [in]           ULONG            Length,
  [in]           BOOLEAN          ReturnSingleEntry,
  [in, optional] PVOID            SidList,
  [in]           ULONG            SidListLength,
  [in, optional] PSID             StartSid,
  [in]           BOOLEAN          RestartScan
);

参数

[in] FileHandle

文件对象的句柄，表示为其请求配额信息的文件或卷。

[out] IoStatusBlock

调用方 I/O 状态块的地址。

[out] Buffer

用于接收卷的配额信息的缓冲区。配额信息的格式设置为一个或多个 FILE_QUOTA_INFORMATION 结构。 FILE_QUOTA_INFORMATION 结构中的 NextEntryOffset 字段包含列表中下一个配额条目的偏移量（以字节为单位）。如果当前条目之后没有其他条目，则此成员为零。

[in] Length

缓冲区的长度（以字节为单位）。

[in] ReturnSingleEntry

一个布尔值，指示是否只应返回一个条目，而不是使用尽可能多的条目填充缓冲区。

[in, optional] SidList

要返回其配额信息的 SID 的可选列表。列表中的每个条目都是 一个FILE_GET_QUOTA_INFORMATION 结构。 FILE_GET_QUOTA_INFORMATION 结构中的 NextEntryOffset 字段包含列表中下一个配额条目的偏移量（以字节为单位）。如果当前条目之后没有其他条目，则此成员为零。

[in] SidListLength

SID 列表的长度（如果已指定）。

[in, optional] StartSid

指向要开始扫描配额信息的条目 的 SID 的可选指针。如果返回的信息以第一个 SID 以外的条目开头，则应设置此参数。如果指定 了 SidList 参数，则忽略此参数。

[in] RestartScan

一个布尔值，指示是否从头开始重启配额信息的扫描。如果从卷配额信息列表中的第一个条目开始扫描配额信息，请将此参数设置为 TRUE 。如果从先前调用 NtQueryQuotaInformationFile 恢复扫描，则设置为 FALSE。首次调用 NtQueryQuotaInformationFile 时，调用方必须将此参数设置为 TRUE。

返回值

如果在 Buffer 参数或适当的 NTSTATUS 值（如以下值之一）中返回了至少一个FILE_QUOTA_INFORMATION结构，NtQueryQuotaInformationFile 例程将返回STATUS_SUCCESS：

返回代码	说明
STATUS_INSUFFICIENT_RESOURCES	资源不足，无法完成操作。这是错误代码。
STATUS_INVALID_DEVICE_REQUEST	卷上未启用配额。这是错误代码。
STATUS_INVALID_SID	StartSid 参数不包含有效的 SID。这是错误代码。
STATUS_QUOTA_LIST_INCONSISTENT	SidList 参数不包含格式正确的有效列表。这是错误代码。

注解

NtQueryQuotaInformationFile 返回的信息量基于与卷关联的配额信息的大小、缓冲区的大小以及是否请求了一组特定的条目。

调用 NtQueryQuotaInformationFile 将导致 将IRP_MJ_SET_QUOTA 请求发送到与文件对象关联的设备对象，该文件对象的句柄存储在 FileHandle 参数中。

如果基础文件系统不支持 FAT 和 CDFS 文件系统 (配额信息（例如) ）， 则 NtQueryQuotaInformationFile 将无法返回STATUS_INVALID_DEVICE_REQUEST。

注意

如果对 NtQueryQuotaInformationFile 函数的调用在内核模式下发生，则应使用名称“ZwQueryQuotaInformationFile”而不是“NtQueryQuotaInformationFile”。

对于来自内核模式驱动程序的调用，Windows 本机系统服务例程的 NtXxx 和 ZwXxx 版本在处理和解释输入参数的方式上的行为可能有所不同。有关例程的 NtXxx 和 ZwXxx 版本之间的关系的详细信息，请参阅使用本机系统服务例程的 Nt 和 Zw 版本。

要求

要求	值
最低受支持的客户端	Windows 7
目标平台	通用
标头	ntifs.h (包括 Ntifs.h、FltKernel.h)
Library	NtosKrnl.lib
DLL	NtosKrnl.exe
IRQL	PASSIVE_LEVEL
DDI 符合性规则	HwStorPortProhibitedDDI，PowerIrpDDis