FltSetVolumeInformation function (fltkernel.h)

Article
02/22/2024

FltSetVolumeInformation changes various kinds of information about the volume that the given instance is attached to.

Syntax

NTSTATUS FLTAPI FltSetVolumeInformation(
  [in]  PFLT_INSTANCE        Instance,
  [out] PIO_STATUS_BLOCK     Iosb,
  [out] PVOID                FsInformation,
  [in]  ULONG                Length,
  [in]  FS_INFORMATION_CLASS FsInformationClass
);

Parameters

[in] Instance

Opaque instance pointer for a minifilter driver instance that is attached to the volume.

[out] Iosb

Pointer to an IO_STATUS_BLOCK structure that receives the final completion status and information about the operation.

[out] FsInformation

Pointer to a caller-allocated buffer containing the values to be set for the volume. The structure of the information contained in the buffer is defined by the FsInformationClass parameter.

[in] Length

Size in bytes of the buffer that FsInformation points to. The caller should set this parameter according to the given FsInformationClass. For example, if the value of FsInformationClass is FileFsControlInformation, Length must be at least sizeof(FILE_FS_CONTROL_INFORMATION).

[in] FsInformationClass

Type of information to be set for the volume. One of the following.

Value	Meaning
FileFsControlInformation	Set FILE_FS_CONTROL_INFORMATION for the volume.
FileFsLabelInformation	Set FILE_FS_LABEL_INFORMATION for the volume.
FileFsObjectIdInformation	Set FILE_FS_OBJECTID_INFORMATION for the volume.

Return value

FltSetVolumeInformation returns STATUS_SUCCESS or an appropriate NTSTATUS value such as one of the following:

Return code	Description
STATUS_INFO_LENGTH_MISMATCH	An invalid value was specified for Length. This is an error code.
STATUS_INSUFFICIENT_RESOURCES	FltSetVolumeInformation encountered a pool allocation failure. This is an error code.
STATUS_INVALID_INFO_CLASS	An invalid value was specified for FsInformationClass. This is an error code.
STATUS_INVALID_PARAMETER	The Instance is attached to a network volume. FltSetVolumeInformation cannot be used to set network volume information. This is an error code.

Remarks

To query information about a volume, call FltQueryVolumeInformation.

Requirements

Requirement	Value
Target Platform	Universal
Header	fltkernel.h (include Fltkernel.h)
Library	FltMgr.lib
DLL	Fltmgr.sys
IRQL	PASSIVE_LEVEL