RemoveIScsiSendTargetPortalA function (iscsidsc.h)

  • Article

The RemoveIscsiSendTargetPortal function removes a portal from the list of portals to which the iSCSI initiator service sends SendTargets requests for target discovery.

Syntax

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

Parameters

[in, optional] InitiatorInstance

The name of the Host Bus Adapter (HBA) that the iSCSI initiator service uses to establish a discovery session and perform SendTargets requests. A value of null indicates that the iSCSI initiator service will use any HBA that is capable of accessing the target portal.

[in, optional] InitiatorPortNumber

The port number on the HBA that the iSCSI initiator service use to perform SendTargets requests.

[in] Portal

A pointer to a structure of type ISCSI_TARGET_PORTAL that specifies the target portal that the iSCSI initiator service removes from its list of portals.

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 RemoveIScsiSendTargetPortal 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

See also

ISCSI_TARGET_PORTAL