usr/src/man/man3stmf/stmfDevidFromWwn.3stmf

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH STMFDEVIDFROMWWN 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfDevidFromWwn \- convert a WWN to a stmfDevid structure
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfDevidFromWWN\fR(\fBuchar_t\fR \fIwwn\fR[8], \fBstmfDevid *\fR\fIdevid\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIwwn\fR\fR
  23 .ad
  24 .RS 9n
  25 The 8-byte WWN identifier.
  26 .RE
  27
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIdevid\fR\fR
  32 .ad
  33 .RS 9n
  34 A pointer to a \fBstmfDevid\fR structure allocated by the caller. On successful
  35 return, this will contain the converted device identifier. On error, the value
  36 of this parameter is undefined.
  37 .RE
  38
  39 .SH DESCRIPTION
  40 .sp
  41 .LP
  42 The stmfDevidFromWwn function convert a WWN to a stmfDevid structure. It
  43 returns the \fIdevid\fR as a SCSI name string.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 The following values are returned:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBSTMF_ERROR_INVALID_ARGUMENT\fR\fR
  52 .ad
  53 .sp .6
  54 .RS 4n
  55 The value of \fIwwn\fR was not valid WWN identifier.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  62 .ad
  63 .sp .6
  64 .RS 4n
  65 The API call was successful.
  66 .RE
  67
  68 .SH ATTRIBUTES
  69 .sp
  70 .LP
  71 See \fBattributes\fR(5) for descriptions of the following attributes:
  72 .sp
  73
  74 .sp
  75 .TS
  76 box;
  77 c | c
  78 l | l .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 Interface Stability     Committed
  82 _
  83 MT-Level        Safe
  84 .TE
  85
  86 .SH SEE ALSO
  87 .sp
  88 .LP
  89 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)