man pages section 3: Extended Library Functions, Volume 4

Exit Print View

Updated: July 2014
 
 

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(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See also

libstmf(3LIB), attributes(5)