ReportIscsiPersistentLogins function

The ReportIscsiPersistentLogins function retrieves the list of persistent login targets.

Syntax


HRESULT WINAPI ReportIscsiPersistentLogins(
  _Out_    ULONG *Count,
  _Inout_  PPERSISTENT_ISCSI_LOGIN_INFO PersistentLoginInfo,
  _Inout_  PULONG BufferSizeInBytes
);

Parameters

Count [out]

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

PersistentLoginInfo [in, out]

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

BufferSizeInBytes [in, out]

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.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Iscsidsc.h

Library

Iscsidsc.lib

DLL

Iscsidsc.dll

Unicode and ANSI names

ReportIscsiPersistentLoginsW (Unicode) and ReportIscsiPersistentLoginsA (ANSI)

See also

PERSISTENT_ISCSI_LOGIN_INFO
AddPersistentIscsiDevice
ClearPersistentIscsiDevices
RemoveIscsiPersistentTarget
RemovePersistentIscsiDevice
ReportPersistentIscsiDevices
SetupPersistentIscsiDevices

 

 

Community Additions

ADD
Show:
© 2015 Microsoft