IVdsDisk3::GetProperties2 method (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.]

Returns property information for a disk. This method is identical to the IVdsDisk::GetProperties method, except that it returns a VDS_DISK_PROP2 structure instead of a VDS_DISK_PROP structure.

Syntax

HRESULT GetProperties2(
  [out] VDS_DISK_PROP2 *pDiskProperties
);

Parameters

[out] pDiskProperties

The address of the VDS_DISK_PROP2 structure allocated and passed in by the caller. VDS allocates memory for the pwszDiskAddress, pwszName, pwszFriendlyName, pwszAdaptorName, pwszDevicePath, and pwszLocationPath member strings. Callers must free the strings by using the CoTaskMemFree function.

Return value

This method can return standard HRESULT values, such as E_INVALIDARG or E_OUTOFMEMORY, and VDS-specific return values. It can also return converted system error codes using the HRESULT_FROM_WIN32 macro. Errors can originate from VDS itself or from the underlying VDS provider that is being used. Possible return values include the following.

Return code/value	Description
S_OK	The properties were returned successfully.
VDS_S_PROPERTIES_INCOMPLETE 0x00042715L	Some but not all of the properties were successfully retrieved. Note that there are many possible reasons for failing to retrieve all properties, including device removal.

Remarks

In the VDS_DISK_PROP2 structure that is returned in the pDiskProperties parameter, the pwszDiskAddress member is optional and can be NULL if no value is available. Callers of this method must check whether this member is NULL.

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

Requirements

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