IVdsProviderPrivate::GetObject method (vdshwprv.h)

[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]

Returns the specified object.

Syntax

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

Parameters

[in] ObjectId

The GUID of the object.

[in] type

The object type enumerated by VDS_OBJECT_TYPE.

[out] ppObjectUnk

The address of an IUnknown pointer for 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
The object was not found.

Remarks

The object can be a subsystem, controller, LUN, LUN plex, drive, pack, disk, volume, or volume plex object. Each object represents a physical device (such as a subsystem, drive, or controllers) or a virtual device (such as a LUN or LUN plex). The hardware provider should create one COM object for each physical or virtual device.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vdshwprv.h
Library Uuid.lib

See also

IVdsProviderPrivate

VDS_OBJECT_TYPE