Share via

3.4.5.2.13.1 IVdsIscsiInitiatorPortal::GetProperties (Opnum 3)

  • Article

The GetProperties method retrieves the properties of the initiator portal that the object exposing this interface and method represents.

 HRESULT GetProperties(
   [out] VDS_ISCSI_INITIATOR_PORTAL_PROP* pInitiatorPortalProp
 );

pInitiatorPortalProp: A pointer to a VDS_ISCSI_INITIATOR_PORTAL_PROP structure that, if the operation is successfully completed, receives the properties of the initiator portal.

Return Values: The method MUST return zero or a non-error HRESULT (as specified in [MS-ERREF]) to indicate success, or return an implementation-specific nonzero error code to indicate failure. For the HRESULT values predefined by the Virtual Disk Service Remote Protocol, see section 2.2.3.

When the server receives this message, it MUST validate the following parameter:

  • Verify that pInitiatorPortalProp is not NULL.

The server MUST populate the VDS_ISCSI_INITIATOR_PORTAL_PROP structure that pInitiatorPortalProp references with the properties of the iSCSI initiator portal and then return an HRESULT indicating failure or success. For information on the VDS_ISCSI_INITIATOR_PORTAL_PROP structure, see section 2.2.2.6.2.2.