Edit

IVdsDrive::GetProperties method (vds.h)

  • Article

[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]

Returns the properties of a drive object.

Syntax

HRESULT GetProperties(
  [out] VDS_DRIVE_PROP *pDriveProp
);

Parameters

[out] pDriveProp

The address of the VDS_DRIVE_PROP structure allocated and passed in by the caller. VDS allocates memory for the pwszFriendlyName and pwszIdentification 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
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.
VDS_E_PROVIDER_CACHE_CORRUPT
0x8004241FL
 This return value signals a software or communication problem inside a provider that caches information about the array. Use the IVdsHwProvider::Reenumerate method followed by the IVdsHwProvider::Refresh method to restore the cache.
VDS_E_OBJECT_DELETED
0x8004240BL
 The drive object is no longer present.

Requirements

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

See also

IVdsDrive

IVdsHwProvider::Reenumerate

IVdsHwProvider::Refresh

VDS_DRIVE_PROP