RemoveIScsiConnection function (iscsidsc.h)

Article
02/22/2024

The RemoveIscsiConnection function removes a connection from an active session.

Syntax

ISDSC_STATUS ISDSC_API RemoveIScsiConnection(
  [in] PISCSI_UNIQUE_SESSION_ID    UniqueSessionId,
  [in] PISCSI_UNIQUE_CONNECTION_ID ConnectionId
);

Parameters

[in] UniqueSessionId

A pointer to a structure of type ISCSI_UNIQUE_SESSION_ID that specifies the unique session identifier of the session that the connection belongs to.

[in] ConnectionId

A pointer to a structure of type ISCSI_UNIQUE_CONNECTION_ID that specifies the connection to remove.

Return value

Returns ERROR_SUCCESS if the operation succeeds. Otherwise, it returns the appropriate Win32 or iSCSI error code.

Remarks

The RemoveIscsiConnection function will not remove the last connection of a session or the leading connection of a session. The caller must close the session by calling LogoutIscsiTarget to remove the last connection.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	iscsidsc.h
Library	Iscsidsc.lib
DLL	Iscsidsc.dll

Share via