.TH "iscsi_ifaces_get" 3 "iscsi_ifaces_get" "June 2023" "API Manual" LINUX
.SH NAME
iscsi_ifaces_get \- Retrieve all iSCSI interfaces.
.SH SYNOPSIS
.B "int" iscsi_ifaces_get
.BI "(struct iscsi_context *" ctx ","
.BI "struct iscsi_iface ***" ifaces ","
.BI "uint32_t *" iface_count ");"
.SH ARGUMENTS
.IP "ctx" 12
Pointer of 'struct iscsi_context'.
If this pointer is NULL, your program will be terminated by assert.
.IP "ifaces" 12
Output pointer of 'struct iscsi_iface' pointer array. Its memory
should be freed by \fBiscsi_ifaces_free\fP.
If this pointer is NULL, your program will be terminated by assert.
.IP "iface_count" 12
Output pointer of uint32_t. Will store the size of
'struct iscsi_iface' pointer array.
.SH "DESCRIPTION"

Retrieves all iSCSI interfaces. For the properties of 'struct iscsi_iface',
please refer to the functions defined in 'libopeniscsiusr_iface.h' file.
The returned results contains default iSCSI interfaces(iser and iscsi_tcp)
and iSCSI interfaces configured in "/etc/iscsi/ifaces/".
Illegal configuration file will be skipped and warned.
To generate iSCSI interface configuration when new card installed, please
use \fBiscsi_default_iface_setup\fP.
.SH "RETURN"
int. Valid error codes are:

* LIBISCSI_OK

* LIBISCSI_ERR_BUG

* LIBISCSI_ERR_NOMEM

* LIBISCSI_ERR_ACCESS

* LIBISCSI_ERR_SYSFS_LOOKUP

Error number could be converted to string by \fBiscsi_strerror\fP.