STMFDEVIDFROMISCSINAME(3STMF) SCSI Target Mode Framework Library Functions
stmfDevidFromIscsiName - convert an iSCSI name to a stmfDevid
structure
cc [ flag... ] file... -lstmf [ library... ]
#include <libstmf.h>
int stmfDevidFromIscsiName(char *iscsiName, stmfDevid *devid);
iscsiName
A character string of UTF-8 encoded Unicode characters
representing the iSCSI name terminated with the Unicode
nul character.
devid
A pointer to a stmfDevid structure allocated by the
caller. On successful return, this will contain the
converted device identifier. On error, the value of this
parameter is undefined.
The stmfDevidFromIscsiName() function converts an iSCSI name to a
stmfDevid structure. It returns the devid as a SCSI name string
identifier.
The following values are returned:
STMF_ERROR_INVALID_ARGUMENT
The value of iscsiName was not valid iSCSI name.
STMF_STATUS_SUCCESS
The API call was successful.
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | Safe |
+--------------------+-----------------+
libstmf(3LIB), attributes(7)
June 9, 2008 STMFDEVIDFROMISCSINAME(3STMF)
NAME
stmfDevidFromIscsiName - convert an iSCSI name to a stmfDevid
structure
SYNOPSIS
cc [ flag... ] file... -lstmf [ library... ]
#include <libstmf.h>
int stmfDevidFromIscsiName(char *iscsiName, stmfDevid *devid);
PARAMETERS
iscsiName
A character string of UTF-8 encoded Unicode characters
representing the iSCSI name terminated with the Unicode
nul character.
devid
A pointer to a stmfDevid structure allocated by the
caller. On successful return, this will contain the
converted device identifier. On error, the value of this
parameter is undefined.
DESCRIPTION
The stmfDevidFromIscsiName() function converts an iSCSI name to a
stmfDevid structure. It returns the devid as a SCSI name string
identifier.
RETURN VALUES
The following values are returned:
STMF_ERROR_INVALID_ARGUMENT
The value of iscsiName was not valid iSCSI name.
STMF_STATUS_SUCCESS
The API call was successful.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | Safe |
+--------------------+-----------------+
SEE ALSO
libstmf(3LIB), attributes(7)
June 9, 2008 STMFDEVIDFROMISCSINAME(3STMF)