Edit

IVdsIscsiInitiatorAdapter::LogoutFromTarget 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.]

Performs a manual logout from an iSCSI target on all iSCSI sessions to the specified target.

Syntax

HRESULT LogoutFromTarget(
  [in]  VDS_OBJECT_ID targetId,
  [out] IVdsAsync     **ppAsync
);

Parameters

[in] targetId

The VDS_OBJECT_ID of the target to logout from.

[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 portal group was successfully deleted.
VDS_E_ISCSI_LOGOUT_FAILED
0x80042709L
 The logout failed.
VDS_E_ISCSI_SESSION_NOT_FOUND
0x8004270AL
 VDS could not find a session matching the specified target.
VDS_E_ISCSI_LOGOUT_INCOMPLETE
0x80042710L
 At least one session did not logout successfully.

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