ReportIScsiPersistentLoginsA function (iscsidsc.h)

Article
02/22/2024

The ReportIscsiPersistentLogins function retrieves the list of persistent login targets.

Syntax

ISDSC_STATUS ISDSC_API ReportIScsiPersistentLoginsA(
  [out]     ULONG                         *Count,
  [in, out] PPERSISTENT_ISCSI_LOGIN_INFOA PersistentLoginInfo,
  [in, out] PULONG                        BufferSizeInBytes
);

Parameters

[out] Count

A pointer to the location that receives a count of the elements specified by PersistentLoginInfo.

[in, out] PersistentLoginInfo

An array of PERSISTENT_ISCSI_LOGIN_INFO structures that, on output, describe the persistent login targets.

[in, out] BufferSizeInBytes

A pointer to a location that, on input, contains the byte-size of the buffer space that PersistentLoginInfo specifies. If the buffer size is insufficient, this parameter specifies what is required to contain the output data.

Return value

Returns ERROR_SUCCESS if the operation succeeds and ERROR_INSUFFICIENT_BUFFER if the buffer specified by PersistentLoginInfo is insufficient to contain the output data.

Otherwise, ReportIscsiPersistentLogins returns the appropriate Win32 or iSCSI error code on failure.

Remarks

The PERSISTENT_ISCSI_LOGIN_INFO structure provides an initiator with the information required to log in to a target each time the initiator device is started.

Note

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