Edit

ReportIScsiSendTargetPortalsExA function (iscsidsc.h)

  • Article

The ReportIscsiSendTargetPortalsEx function retrieves a list of static target portals that the iSCSI initiator service uses to perform automatic discovery with SendTarget requests.

Syntax

ISDSC_STATUS ISDSC_API ReportIScsiSendTargetPortalsExA(
  [out]     PULONG                        PortalCount,
  [in, out] PULONG                        PortalInfoSize,
  [in, out] PISCSI_TARGET_PORTAL_INFO_EXA PortalInfo
);

Parameters

[out] PortalCount

A pointer to a location that, on input, contains the number of entries in the PortalInfo array. On output, this parameter specifies the number of elements that contain return data.

[in, out] PortalInfoSize

A pointer to a location that, on input, contains the byte-size of the buffer specified by PortalInfo. On output, this parameter specifies the number of bytes retrieved.

[in, out] PortalInfo

Pointer to an array of elements contained in a ISCSI_TARGET_PORTAL_INFO_EX structure that describe the portals that the iSCSI initiator service utilizes to perform discovery with SendTargets requests.

Return value

Returns ERROR_SUCCESS if the operation succeeds and ERROR_INSUFFICIENT_BUFFER if the size of the buffer at PortalInfo is insufficient to contain the output data. Otherwise, ReportIscsiSendTargetPortalsEx returns the appropriate Win32 or iSCSI error code on failure.

Remarks

Note

The iscsidsc.h header defines ReportIScsiSendTargetPortalsEx 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_INFO_EX