Edit

FltQueryQuotaInformationFile function (fltkernel.h)

  • Article

The FltQueryQuotaInformationFile routine retrieves quota entries associated with a file object.

Syntax

NTSTATUS FLTAPI FltQueryQuotaInformationFile(
  [in]            PFLT_INSTANCE    Instance,
  [in]            PFILE_OBJECT     FileObject,
  [out]           PIO_STATUS_BLOCK IoStatusBlock,
  [out]           PVOID            Buffer,
  [in]            ULONG            Length,
  [in]            BOOLEAN          ReturnSingleEntry,
  [in, optional]  PVOID            SidList,
  [in]            ULONG            SidListLength,
  [in, optional]  PULONG           StartSid,
  [in]            BOOLEAN          RestartScan,
  [out, optional] PULONG           LengthReturned
);

Parameters

[in] Instance

An opaque instance pointer for the caller. This parameter is required and cannot be NULL.

[in] FileObject

A file object pointer for an open file, directory, storage device, or volume. This parameter is required and cannot be NULL.

[out] IoStatusBlock

A caller-supplied IO_STATUS_BLOCK to receive the result of the call to FltQueryQuotaInformationFile. If the call fails because of an invalid SID list, the Information field will contain the location in SidList where the error occurred.

[out] Buffer

A pointer to a caller-supplied FILE_GET_QUOTA_INFORMATION-structured input buffer where the quota information values are to be returned.

[in] Length

The length, in bytes, of the buffer that the Buffer parameter points to.

[in] ReturnSingleEntry

Set to TRUE if FltQueryQuotaInformationFile should return only the first entry that is found.

[in, optional] SidList

A pointer to a caller-supplied FILE_GET_QUOTA_INFORMATION-structured input buffer that specifies the quota information to be queried. This parameter is optional and can be NULL.

[in] SidListLength

The length, in bytes, of the buffer that the SidList parameter points to.

[in, optional] StartSid

The index of the entry at which to begin scanning the file's quota information list. This parameter is ignored if the SidList parameter points to a nonempty list. This parameter is optional and can be NULL.

[in] RestartScan

Set to TRUE if FltQueryQuotaInformationFile should begin the scan at the first entry in the file's quota information list. If this parameter is not set to TRUE, the scan is resumed from a previous call to FltQueryQuotaInformationFile.

[out, optional] LengthReturned

A pointer to a caller-allocated variable that receives the size, in bytes, of the information returned in Buffer. This parameter is optional and can be NULL.

Return value

FltQueryQuotaInformationFile returns STATUS_SUCCESS or an appropriate NTSTATUS value such as the following.

Return code Description
STATUS_FLT_DELETING_OBJECT
 The instance or volume is being torn down. This is an error code.

Requirements

Requirement Value
Minimum supported client Available starting with Windows 8.
Target Platform Universal
Header fltkernel.h (include Fltkernel.h)
Library FltMgr.lib
DLL Fltmgr.sys
IRQL PASSIVE_LEVEL

See also

FILE_GET_QUOTA_INFORMATION

FltSetQuotaInformationFile

ZwQueryQuotaInformationFile