share/man/man3stmf/stmfGetLogicalUnitProperties.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 STMFGETLOGICALUNITPROPERTIES 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfGetLogicalUnitProperties \- retrieve the properties of the specified
   9 logical unit
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  14 #include <libstmf.h>
  15
  16 \fBint\fR \fBstmfGetLogicalUnitProperties\fR(\fBstmfGuid *\fR\fIlogicalUnit\fR,
  17      \fBstmfLogicalUnitProperties *\fR\fIlogicalUnitProps\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIlogicalUnit\fR\fR
  25 .ad
  26 .RS 20n
  27 The identifier of the logical unit whose properties are being retrieved.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIlogicalUnitProps\fR\fR
  34 .ad
  35 .RS 20n
  36 A pointer to an \fBstmfLogicalUnitProperties\fR structure. On successful
  37 return, this will contain the properties for the specified
  38 \fIlogicalUnitOid\fR.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBstmfGetLogicalUnitProperties()\fR function retrieves the properties of
  45 the specified logical unit.
  46 .SH RETURN VALUES
  47 .sp
  48 .LP
  49 The following values are returned:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBSTMF_ERROR_LOGICAL_UNIT_NOT_REGISTERED\fR\fR
  54 .ad
  55 .sp .6
  56 .RS 4n
  57 The \fIlogicalUnit\fR is not a valid registered logical unit in the system.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 The API call was successful.
  68 .RE
  69
  70 .SH ATTRIBUTES
  71 .sp
  72 .LP
  73 See \fBattributes\fR(5) for descriptions of the following attributes:
  74 .sp
  75
  76 .sp
  77 .TS
  78 box;
  79 c | c
  80 l | l .
  81 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  82 _
  83 Interface Stability     Committed
  84 _
  85 MT-Level        Safe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)