IVdsIscsiInitiatorAdapter::LoginToTarget method (vds.h)

[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]

Performs a manual login to an iSCSI target.

Syntax

HRESULT LoginToTarget(
  [in]  VDS_ISCSI_LOGIN_TYPE loginType,
  [in]  VDS_OBJECT_ID        targetId,
  [in]  VDS_OBJECT_ID        targetPortalId,
  [in]  VDS_OBJECT_ID        initiatorPortalId,
  [in]  ULONG                ulLoginFlags,
  [in]  BOOL                 bHeaderDigest,
  [in]  BOOL                 bDataDigest,
  [in]  VDS_ISCSI_AUTH_TYPE  authType,
  [out] IVdsAsync            **ppAsync
);

Parameters

[in] loginType

The type of login that will be performed, enumerated by VDS_ISCSI_LOGIN_TYPE.

[in] targetId

The VDS_OBJECT_ID of the target to login to. GUID_NULL indicates that the initiator is to select the portal.

[in] targetPortalId

The VDS_OBJECT_ID of the target portal by which the login operation is performed. GUID_NULL indicates that the initiator is to select the portal.

[in] initiatorPortalId

The VDS_OBJECT_ID of the initiator portal by which the login operation is performed.

[in] ulLoginFlags

Flags enumerated by VDS_ISCSI_LOGIN_FLAG specifying login options.

[in] bHeaderDigest

If TRUE, the initiator should enable header digest when logging into the target portal.

[in] bDataDigest

If TRUE, the initiator should enable data digest when logging into the target portal.

[in] authType

The type of authentication required to log into the target, enumerated by VDS_ISCSI_AUTH_TYPE.

[out] ppAsync

The address of an IVdsAsync interface pointer. VDS initializes the interface on return. Callers must release the interface. Use this interface to cancel, wait for, or query the status of the operation. If IVdsAsync::Wait is called on this interface and a success HRESULT value is returned, the interfaces returned in the VDS_ASYNC_OUTPUT structure must be released by calling the IUnknown::Release method on each interface pointer. However, if Wait returns a failure HRESULT value, or if the pHrResult parameter of Wait receives a failure HRESULT value, the interface pointers in the VDS_ASYNC_OUTPUT structure are NULL and do not need to be released. You can test for success or failure HRESULT values by using the SUCCEEDED and FAILED macros defined in Winerror.h.

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 login was successfully completed.
VDS_E_ISCSI_LOGIN_FAILED 0x80042708L	Another operation is in progress. This operation cannot proceed until the previous operations are complete.

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

IVdsAsync

IVdsIscsiInitiatorAdapter

VDS_ISCSI_AUTH_TYPE

VDS_ISCSI_LOGIN_FLAG

VDS_ISCSI_LOGIN_TYPE