GetIScsiIKEInfoA function (iscsidsc.h)

Article
11/20/2024

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

Syntax

ISDSC_STATUS ISDSC_API GetIScsiIKEInfoA(
  [in, optional] PSTR                            InitiatorName,
  [in]           ULONG                           InitiatorPortNumber,
  [in]           PULONG                          Reserved,
  [in]           PIKE_AUTHENTICATION_INFORMATION AuthInfo
);

Parameters

[in, optional] InitiatorName

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

[in] InitiatorPortNumber

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.

[in] Reserved

This value is reserved.

[in] AuthInfo

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.

Remarks

Note

The iscsidsc.h header defines GetIScsiIKEInfo as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

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