KsQueryInformationFile function (ks.h)

Article
03/15/2022

The KsQueryInformationFile function performs an information query against the specified file object. The function attempts to use FastIoDispatch if possible, or it generates an information request against the device object.

Syntax

KSDDKAPI NTSTATUS KsQueryInformationFile(
  [in]  PFILE_OBJECT           FileObject,
  [out] PVOID                  FileInformation,
  [in]  ULONG                  Length,
  [in]  FILE_INFORMATION_CLASS FileInformationClass
);

Parameters

[in] FileObject

Specifies the file object from which to query the standard information.

[out] FileInformation

Indicates the place in which to put the file information. This is assumed to be a valid or probed address.

[in] Length

Specifies the correct length of the FileInformation buffer.

[in] FileInformationClass

Specifies the class of information being requested.

Return value

The KsQueryInformationFile function returns STATUS_SUCCESS if successful, or if unsuccessful it returns a query error.

Remarks

The KsQueryInformationFile function should only be used in cases where the query would result in an actual request to the underlying driver. For example, FilePositionInformation would not generate such a request and should not be used. It assumes the caller is serializing access to the file for operations against a FO_SYNCHRONOUS_IO file object.

Requirements

Requirement	Value
Target Platform	Universal
Header	ks.h (include Ks.h)
Library	Ks.lib

Share via