Edit

IVdsIscsiInitiatorPortal::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.]

Returns the properties of an initiator portal.

Syntax

HRESULT GetProperties(
  [out] VDS_ISCSI_INITIATOR_PORTAL_PROP *pInitiatorPortalProp
);

Parameters

[out] pInitiatorPortalProp

The address of a VDS_ISCSI_INITIATOR_PORTAL_PROP structure allocated 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 returned successfully.
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.

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
Library Uuid.lib
Redistributable VDS 1.1

See also

IVdsIscsiInitiatorPortal

VDS_ISCSI_INITIATOR_PORTAL_PROP