Share via

3.4.5.2.32.1 IVdsVolume::GetProperties (Opnum 3)

  • Article

The GetProperties method retrieves the properties of the volume that is represented by the object exposing this interface and method.

 HRESULT GetProperties(
   [out] VDS_VOLUME_PROP* pVolumeProperties
 );

pVolumeProperties: A pointer to a VDS_VOLUME_PROP structure that, if the operation is successfully completed, receives the properties of the volume.

Return Values: The method MUST return zero or a non-error HRESULT (as specified in [MS-ERREF]) to indicate success, or return an implementation-specific nonzero error code to indicate failure. For the HRESULT values predefined by the Virtual Disk Service Remote Protocol, see section 2.2.3.

When the server receives this message, it MUST validate the following parameter:

  • Verify that pVolumeProperties is not NULL.

The server MUST populate the VDS_VOLUME_PROP structure that pVolumeProperties references with the properties of the volume, and then return an HRESULT indicating failure or success. For information on VDS_VOLUME_PROP, see section 2.2.2.14.1.1.