VDS_DISK_PROP2 structure (vds.h)

Article
02/09/2023

[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 disk object. This structure is identical to the VDS_DISK_PROP structure, except that it also includes the location path and, if the disk is offline, the reason why it is offline.

Syntax

typedef struct _VDS_DISK_PROP2 {
  VDS_OBJECT_ID           id;
  VDS_DISK_STATUS         status;
  VDS_DISK_OFFLINE_REASON OfflineReason;
  VDS_LUN_RESERVE_MODE    ReserveMode;
  VDS_HEALTH              health;
  DWORD                   dwDeviceType;
  DWORD                   dwMediaType;
  ULONGLONG               ullSize;
  ULONG                   ulBytesPerSector;
  ULONG                   ulSectorsPerTrack;
  ULONG                   ulTracksPerCylinder;
  ULONG                   ulFlags;
  VDS_STORAGE_BUS_TYPE    BusType;
  VDS_PARTITION_STYLE     PartitionStyle;
  union {
    DWORD dwSignature;
    GUID  DiskGuid;
  };
  LPWSTR                  pwszDiskAddress;
  LPWSTR                  pwszName;
  LPWSTR                  pwszFriendlyName;
  LPWSTR                  pwszAdaptorName;
  LPWSTR                  pwszDevicePath;
  LPWSTR                  pwszLocationPath;
} VDS_DISK_PROP2, *PVDS_DISK_PROP2;

Members

id

The GUID of the disk object.

status

A VDS_DISK_STATUS enumeration value that specifies the status of the disk.If the VDS service cannot open a handle to the disk, it sets this member to VDS_DS_UNKNOWN.

Note This member can be VDS_DS_ONLINE, even if the status of the containing pack is VDS_PS_OFFLINE.

OfflineReason

If the disk is offline, this member is a VDS_DISK_OFFLINE_REASON enumeration value that specifies the reason why it is offline.

ReserveMode

This member is reserved for future use.

health

A VDS_HEALTH enumeration value that specifies the health state of the disk. The following are the valid values for this member.

VDS_H_UNKNOWN (0)

VDS_H_HEALTHY (1)

VDS_H_FAILING (4)

VDS_H_FAILED (8)

dwDeviceType

The device type defined in Winioctl.h, which includes the following types among others:

dwMediaType

A media type enumerated by STORAGE_MEDIA_TYPE. Basic and dynamic disks map to the FixedMedia enumerator. For more information, see STORAGE_MEDIA_TYPE.

ullSize

The size of the disk in bytes. To determine the maximum volume size for a disk, call IVdsDisk3::QueryFreeExtents and add the sizes of all free extents.

ulBytesPerSector

The number of bytes in each sector.

ulSectorsPerTrack

The number of sectors in each track.

ulTracksPerCylinder

The number of tracks in each cylinder.

ulFlags

A bitmask of VDS_DISK_FLAG enumeration values that specify various disk attributes.

BusType

The input/output bus types enumerated by VDS_STORAGE_BUS_TYPE.

PartitionStyle

A VDS_PARTITION_STYLE enumeration that specifies the partition style. This member is the discriminant for the union.

dwSignature

Used if PartitionStyle is VDS_PST_MBR (1). The signature for the MBR partition. This value is not guaranteed to be unique.

DiskGuid

Used if PartitionStyle is VDS_PST_GPT (2). The
GUID for the disk. In addition, each GPT partition has its own GUID. (See VDS_PARTITION_INFO_GPT.)

pwszDiskAddress

The address of a SCSI-like disk in PortNNNPathNNNTargetNNNLunNNN format, where NNN is one or more digits.

SCSI disks, IDE disks, and Fibre Channel disks can have such an address. USB and 1394 disks have different address formats and are not stored.

This member is optional and can be NULL if no value is available. If it is not NULL, its length must be greater than or equal to 22 WCHAR and less than or equal to 64 WCHAR, including the required NULL terminator. Applications that receive the VDS_DISK_PROP2 structure by calling IVdsDisk3::GetProperties2 must check whether this member is NULL.

pwszName

The name used to open a handle to an object created using the CreateFile function. For example:

pwszFriendlyName

The name returned by the Plug and Play (PnP) Manager. This name is maintained in the Windows registry by the Plug and Play Manager, for example: "SEAGATE ST34573N SCSI Disk Device".

pwszAdaptorName

The name of the adapter to which this disk is attached. The PnP Manager returns the name, which is maintained in the Windows registry, for example: "Adaptec AHA-2940U2W - Ultra2 SCSI".

pwszDevicePath

The string returned by the PnP Manager. The PnP Manager uses the device path to uniquely identify a device on a computer. For more information, see SP_DEVICE_INTERFACE_DETAIL_DATA_W.

pwszLocationPath

A string that contains the PnP location path of the disk. The format of this string depends on the bus type. If the bus type is SCSI, SAS, or PCI RAID, the format is AdapterPnpLocationPath#BusType(PPathIdTTargetIdLLunId). If the bus type is IDE, ATA, PATA, or SATA, the format is AdapterPnpLocationPath#BusType(CPathIdTTargetIdLLunId). See the following Remarks section for a table that lists the parts of this string.

Note For Hyper-V, this member is NULL, because the virtual controller does not return the location path.

Remarks

The IVdsDisk3::GetProperties2 method returns this structure to report the properties of a disk object.

The following table lists the parts of the location path string used in the pwszLocationPath member.

Location path part	Description
AdapterPnpLocationPath	The adapter's PnP location path. This is retrieved by calling the SetupDiGetDeviceProperty function, passing &DEVPKEY_Device_LocationPaths for the PropertyKey parameter.
BusType	The bus type: ATA, RAID, SAS, or SCSI. Note If the bus type is IDE, PATA, or SATA, it appears as ATA in the location path string. If it is PCI RAID, it appears as RAID.
PathId	The number of the bus. This is the value of the PathId member of the SCSI_ADDRESS structure that is returned by the IOCTL_SCSI_GET_ADDRESS control code.
TargetId	The number of the target device. This is the value of the TargetId member of the SCSI_ADDRESS structure that is returned by the IOCTL_SCSI_GET_ADDRESS control code.
LunId	The number of the LUN. This is the value of the Lun member of the SCSI_ADDRESS structure that is returned by the IOCTL_SCSI_GET_ADDRESS control code.

The following table contains examples of location paths.

Bus type	Example location path
ATA	PCIROOT(0)#PCI(0100)#ATA(C01T03L00)
RAID	PCIROOT(0)#PCI(0200)#PCI(0003)#PCI(0100)#RAID(P02T00L00)
SAS	PCIROOT(1)#PCI(0300)#SAS(P00T03L00)
SCSI	PCIROOT(0)#PCI(1C00)#PCI(0000)#SCSI(P00T01L01)

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Header	vds.h