VDS_VOLUME_PROP structure (vds.h)
[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]
Defines the properties of a volume object.
Syntax
typedef struct _VDS_VOLUME_PROP {
VDS_OBJECT_ID id;
VDS_VOLUME_TYPE type;
VDS_VOLUME_STATUS status;
VDS_HEALTH health;
VDS_TRANSITION_STATE TransitionState;
ULONGLONG ullSize;
ULONG ulFlags;
VDS_FILE_SYSTEM_TYPE RecommendedFileSystemType;
LPWSTR pwszName;
} VDS_VOLUME_PROP, *PVDS_VOLUME_PROP;
Members
id
The GUID of the volume.
type
A VDS_VOLUME_TYPE enumeration value that specifies the type of the volume. Volume types are simple, spanned, striped (RAID-0), mirrored, or striped with parity (RAID-5).
status
A VDS_VOLUME_STATUS enumeration value that specifies the status of the volume.
health
A VDS_HEALTH enumeration value that specifies the health state of the volume.
TransitionState
A VDS_TRANSITION_STATE enumeration value that specifies the transition state of the volume.
ullSize
The size of the volume, in bytes.
ulFlags
A bitmask of VDS_VOLUME_FLAG enumeration values that describe the volume.
RecommendedFileSystemType
A VDS_FILE_SYSTEM_TYPE enumeration value that specifies the preferred file system for the volume. Must be one of the following: VDS_FST_NTFS, VDS_FST_FAT, VDS_FST_FAT32, VDS_FST_UDF, VDS_FST_CDFS, or VDS_FST_UNKNOWN.
pwszName
The name used to open a handle for the volume with the CreateFile function. For example, \?\GLOBALROOT\Device\HarddiskVolume1.
Remarks
The IVdsVolume::GetProperties method returns this structure to report the properties of a volume object.
When a volume is offline, the VDS_VF_PERMANENTLY_DISMOUNTED flag is set in the ulFlags member of the VDS_VOLUME_PROP structure, and the VDS_VS_OFFLINE volume status value is also set in the status member of this structure.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Header | vds.h |