FltIsVolumeSnapshot function (fltkernel.h)

Article
02/22/2024

The FltIsVolumeSnapshot routine determines whether a volume or minifilter driver instance is attached to a snapshot volume.

Syntax

NTSTATUS FLTAPI FltIsVolumeSnapshot(
  [in]  PVOID    FltObject,
  [out] PBOOLEAN IsSnapshotVolume
);

Parameters

[in] FltObject

An opaque pointer to the volume or instance.

[out] IsSnapshotVolume

A pointer to a caller-allocated Boolean variable that receives TRUE if the volume or instance is attached to a snapshot volume. Otherwise, the variable receives FALSE.

Return value

FltIsVolumeSnapshot returns one of the following NTSTATUS values:

Return code	Description
STATUS_SUCCESS	FltIsVolumeSnapshot determined whether FltObject is a snapshot.
STATUS_INVALID_PARAMETER	FltObject specifies something besides a volume or an instance. This is an error code.
STATUS_FLT_NO_DEVICE_OBJECT	FltObject does not have an associated disk device object. This can occur if FltObject is associated with a network drive. This is an error code.
STATUS_INSUFFICIENT_RESOURCES	FltIsVolumeSnapshot encountered a memory allocation failure. This is an error code.

Remarks

If the volume or instance object does not support snapshots, FltIsVolumeSnapshot returns STATUS_SUCCESS and IsSnapshotVolume is FALSE.

Requirements

Requirement	Value
Minimum supported client	Available in Windows Vista and later versions of Windows.
Target Platform	Universal
Header	fltkernel.h (include Fltkernel.h)
Library	Fltmgr.lib
DLL	FltMgr.sys
IRQL	PASSIVE_LEVEL

Share via