stmfdevidfromiscsiname(3stmf) [opensolaris man page]

stmfDevidFromIscsiName(3STMF)			   SCSI Target Mode Framework Library Functions 		     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 iden-
		    tifier. 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  identi-
       fier.

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)

SunOS 5.11							    9 Jun 2008					     stmfDevidFromIscsiName(3STMF)