IVdsService::GetObject 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 an object pointer for the identified object.

Syntax

HRESULT GetObject(
  [in]  VDS_OBJECT_ID   ObjectId,
  [in]  VDS_OBJECT_TYPE type,
  [out] IUnknown        **ppObjectUnk
);

Parameters

[in] ObjectId

The GUID of the desired object.

[in] type

A VDS_OBJECT_TYPE enumeration value that specifies the object type. VDS_OT_UNKNOWN, VDS_OT_PROVIDER, VDS_OT_ASYNC, VDS_OT_ENUM, and VDS_OT_OPEN_VDISK are not supported.

[out] ppObjectUnk

A pointer to a buffer that receives the IUnknown pointer to the object. When the pointer is no longer needed, the caller should release it by calling the IUnknown::Release method.

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_E_OBJECT_NOT_FOUND
0x80042405L
 An object with the specified identifier and type is not found.
VDS_E_INITIALIZED_FAILED
0x80042401L
 VDS failed to initialize. If an application calls this method before the service finishes initializing, the method is blocked until the initialization completes. If the initialization fails, this error is returned.

Remarks

VDS notifications return an object identifier instead of an object pointer. Callers use this method to get a pointer to the object referenced in the notification.

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

IVdsService

VDS_OBJECT_TYPE