IVdsHbaPort::GetProperties 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.]

Retrieves the properties of an HBA port.

Syntax

HRESULT GetProperties(
  [out] VDS_HBAPORT_PROP *pHbaPortProp
);

Parameters

[out] pHbaPortProp

The address of a member of the VDS_HBAPORT_PROP structure that is allocated and passed in by the caller.

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
S_OK
 The properties were successfully returned.
VDS_S_PROPERTIES_INCOMPLETE
0x00042715L
 Some but not all of the properties were successfully retrieved. Note that there are many possible reasons for failing to retrieve all properties, including device removal.
E_POINTER
 The pHbaPortProp parameter is not a valid pointer.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 R2 [desktop apps only]
Target Platform Windows
Header vds.h

See also

IVdsHbaPort

VDS_HBAPORT_PROP