4.4 Retrieving the Properties and IDs of VDS Objects

After an object is retrieved, a common task is to look for the VDS object ID, which uniquely identifies the object and is located in the object's properties structure.

The following figure shows how to retrieve the properties of a volume object, if one exists. For information on how to retrieve a reference to a volume object, see section 4.3.

Retrieving the properties of a volume object

Figure 8: Retrieving the properties of a volume object

  1. The client calls the IVdsVolume::GetProperties method, passing in a reference to a VDS_VOLUME_PROP structure in which to store the properties.

  2. After successful execution of IVdsVolume::GetProperties, the server returns the properties of the volume, which includes its VDS object ID in the client-provided VDS_VOLUME_PROP structure.

After successful execution of the IVdsVolume::GetProperties request, which returns a filled VDS_VOLUME_PROP structure, the client can inspect any members of that structure.

The properties of other VDS objects can be retrieved by using similar steps.