RefreshIScsiSendTargetPortalA function (iscsidsc.h)

Article
02/22/2024

The RefreshIscsiSendTargetPortal function instructs the iSCSI initiator service to establish a discovery session with the indicated target portal and transmit a SendTargets request to refresh the list of discovered targets for the iSCSI initiator service.

Syntax

ISDSC_STATUS ISDSC_API RefreshIScsiSendTargetPortalA(
  [in, optional] PSTR                  InitiatorInstance,
  [in]           ULONG                 InitiatorPortNumber,
  [in]           PISCSI_TARGET_PORTALA Portal
);

Parameters

[in, optional] InitiatorInstance

The name of the Host Bus Adapter (HBA) to use for the SendTargets request. If null, the iSCSI initiator service uses any HBA that can reach the indicated target portal is chosen.

[in] InitiatorPortNumber

The port number on the HBA to use for the SendTargets request. If the value is ISCSI_ALL_INITIATOR_PORTS, the initiator HBA will choose the appropriate port based upon current routing information.

[in] Portal

A pointer to a structure of type ISCSI_TARGET_PORTAL indicating the portal to which the iSCSI initiator service sends the SendTargets request to refresh the list of targets.

Return value

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

Remarks

Note

The iscsidsc.h header defines RefreshIScsiSendTargetPortal as an alias which 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 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