stmfDevidFromIscsiName.3stmf revision c10c16dec587a0662068f6e2991c29ed3a9db943
te
Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
stmfDevidFromIscsiName 3STMF "9 Jun 2008" "SunOS 5.11" "SCSI Target Mode Framework Library Functions"
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)