Edit

IVdsServiceIscsi::GetInitiatorName 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 iSCSI name of the local initiator service.

Syntax

HRESULT GetInitiatorName(
  [out] LPWSTR *ppwszIscsiName
);

Parameters

[out] ppwszIscsiName

The address of a pointer to a string. VDS will put a pointer to an initialized string at this location. Callers must free the string by using the CoTaskMemFree function.

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 Description
S_OK
 The name was returned successfully.
E_POINTER
 The ppwszIscsiName 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
Library Uuid.lib
Redistributable VDS 1.1

See also

IVdsServiceIscsi