Share via

3.4.5.2.19.1 IVdsPack::GetProperties (Opnum 3)

  • Article

The GetProperties method retrieves the properties of the disk pack that the object exposing this interface and method represents.

 HRESULT GetProperties(
   [out] VDS_PACK_PROP* pPackProp
 );

pPackProp: A pointer to a VDS_PACK_PROP structure (section 2.2.2.8.2.1) that, if the operation is successfully completed, receives the properties of the pack.

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 pPackProp is not NULL.

The server MUST populate the VDS_PACK_PROP structure (section 2.2.2.8.2.1) that pPackProp references with the properties of the pack. It MUST then return an HRESULT indicating failure or success.