NtDoc

No description available.

Windows hardware development documentation (fsctl-is-volume-dirty)

FSCTL_IS_VOLUME_DIRTY control code

The FSCTL_IS_VOLUME_DIRTY control code determines whether the specified volume is dirty.

If the volume information file is corrupted, NTFS will return STATUS_FILE_CORRUPT_ERROR.

To perform this operation, minifilter drivers call FltFsControlFile with the following parameters, and file systems, redirectors, and legacy file system filter drivers call ZwFsControlFile with the following parameters.

Parameters

FileObject [in]: FltFsControlFile only. File object pointer for the volume. This parameter must represent a user volume open of a mounted file system volume. This parameter is required and cannot be NULL.
FileHandle [in]: ZwFsControlFile only. Handle for the volume. This parameter must be a handle for a user volume open of a mounted file system volume. This parameter is required and cannot be NULL.
FsControlCode [in]: Control code for the operation. Use FSCTL_IS_VOLUME_DIRTY for this operation.
InputBuffer [in]: Not used with this operation; set to NULL.
InputBufferLength [in]: Not used with this operation; set to zero.
OutputBuffer [out]: Pointer to a caller-allocated, 32-bit-aligned buffer that receives a ULONG bitmask of flags that indicate whether the volume is currently dirty. One or more of the flags in the following table can be set.

Value Meaning

VOLUME_IS_DIRTY The volume is dirty.

VOLUME_UPGRADE_SCHEDULED This value is not currently used.

All other values Reserved for future use.
OutputBufferLength [out]: Size, in bytes, of the buffer that is pointed to by the OutputBuffer parameter. This size must be at least sizeof(ULONG).

Value	Meaning
VOLUME_IS_DIRTY	The volume is dirty.
VOLUME_UPGRADE_SCHEDULED	This value is not currently used.
All other values	Reserved for future use.

Status block

FltFsControlFile or ZwFsControlFile returns STATUS_SUCCESS if the operation succeeds. Otherwise, the appropriate function might return one of the following NTSTATUS values:

Code	Meaning
STATUS_INSUFFICIENT_RESOURCES	The file system encountered a pool allocation failure. This is an error code.
STATUS_INVALID_PARAMETER	The buffer that the OutputBuffer parameter points to is NULL, or the FileHandle or FileObject parameter does not represent a user volume open. This is an error code.
STATUS_INVALID_USER_BUFFER	The buffer that the OutputBuffer parameter points to is not large enough to hold the reparse point data, or the FileHandle or FileObject parameter does not represent a user volume open. This is an error code.
STATUS_VOLUME_DISMOUNTED	The volume is not mounted. This is an error code.

Requirements

Requirement type	Requirement
Header	Ntifs.h (include Ntifs.h or Fltkernel.h)