GetIscsiIKEInfo function

The GetIscsiIKEInfo function retrieves the IPsec policy and any established pre-shared key values associated with an initiator Host-Bus Adapter (HBA).

Syntax


HRESULT WINAPI GetIscsiIKEInfo(
  _In_opt_ PTCHAR                          InitiatorName,
  _In_     ULONG                           PortNumber,
  _In_     PULONG                          Reserved,
  _In_     PIKE_AUTHENTICATION_INFORMATION *AuthInfo
);

Parameters

InitiatorName [in, optional]

A string that represents the name of the initiator HBA for which the IPsec policy is established.

PortNumber [in]

A ULONG value that represents the port on the initiator HBA with which to associate the key. If this parameter specifies a value of ISCSI_ALL_INITIATOR_PORTS, all ports on the initiator are associated with the key.

Reserved [in]

This value is reserved.

AuthInfo [in]

A pointer to an IKE_AUTHENTICATION_INFORMATION structure that contains data specifying the authentication method. Currently, only the IKE_AUTHENTICATION_PRESHARED_KEY_METHOD is supported.

Return value

Returns ERROR_SUCCESS if the operation is successful. If the operation fails due to a socket connection error, this function will return a Winsock error code.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Iscsidsc.h

Library

Iscsidsc.lib

DLL

Iscsidsc.dll

Unicode and ANSI names

GetIscsiIKEInfoW (Unicode) and GetIscsiIKEInfoA (ANSI)

 

 

Community Additions

ADD
Show: