Share via

3.4.5.2.14.1 IVdsProvider::GetProperties (Opnum 3)

  • Article

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

 HRESULT GetProperties(
   [out] VDS_PROVIDER_PROP* pProviderProp
 );

pProviderProp: A pointer to a VDS_PROVIDER_PROP structure (section 2.2.2.7.2.1) that, if the operation is successfully completed, receives the properties of the provider.

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

The server MUST populate the VDS_PROVIDER_PROP structure (section 2.2.2.7.2.1) that pProviderProp references with the properties of the provider. It MUST then return an HRESULT indicating failure or success.