Share via

3.4.5.2.8.1 IVdsServiceIscsi::GetInitiatorName (Opnum 3)

  • Article

The GetInitiatorName method returns the iSCSI name of the initiator service.

 HRESULT GetInitiatorName(
   [out, string] WCHAR** ppwszIscsiName
 );

ppwszIscsiName: A pointer that, if the operation is successfully completed, receives a null-terminated Unicode string with the iSCSI name.

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 ppwszIscsiName is not NULL.

The server MUST set ppwszIscsiName to point to a string that contains the iSCSI name of the iSCSI initiator on the system and return an HRESULT indicating failure or success.