NAME

iscsi_iface_get - Retrieve specified iSCSI interface.

SYNOPSIS

int iscsi_iface_get (struct iscsi_context *ctx, const char *iface_name, struct iscsi_iface **iface);

ARGUMENTS

ctx

Pointer of 'struct iscsi_context'. If this pointer is NULL, your program will be terminated by assert.

iface_name

String. Name of iSCSI interface. Also the file name of configuration file "/etc/iscsi/iface/<iface_name>". If this pointer is NULL or empty string, your program will be terminated by assert.

iface

Output pointer of 'struct iscsi_iface'. Its memory should be freed by iscsi_iface_free. If this pointer is NULL, your program will be terminated by assert.

DESCRIPTION

Retrieves specified iSCSI interfaces by reading configuration from "/etc/iscsi/iface/<iface_name>". To generate iSCSI interface configuration when new card installed, please use iscsi_default_iface_setup. Illegal configuration file will be treated as error LIBISCSI_ERR_IDBM. Configuration file not found will be treated as error LIBISCSI_ERR_INVAL.

RETURN

int. Valid error codes are:

* LIBISCSI_OK

* LIBISCSI_ERR_BUG

* LIBISCSI_ERR_NOMEM

* LIBISCSI_ERR_ACCESS

* LIBISCSI_ERR_SYSFS_LOOKUP

* LIBISCSI_ERR_IDBM

Error number could be converted to string by iscsi_strerror.