usr/src/man/man3stmf/stmfAddViewEntry.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 STMFADDVIEWENTRY 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfAddViewEntry \- add a view entry for a given logical unit
   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 \fBstmfAddViewEntry\fR(\fBstmfGuid *\fR\fIlogicalUnit\fR,
  16      \fBstmfViewEntry *\fR\fIviewEntry\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIlogicalUnit\fR\fR
  24 .ad
  25 .RS 15n
  26 The identifier of the logical unit to which this view entry is being added.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIviewEntry\fR\fR
  33 .ad
  34 .RS 15n
  35 The view entry to add to the specified logical unit identifier.
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBstmfAddViewEntry()\fR function adds a view entry for a given logical
  42 unit.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 The following values are returned:
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBSTMF_ERROR_LUN_IN_USE\fR\fR
  51 .ad
  52 .RS 26n
  53 The specified logical unit number is already in use for this logical unit.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBSTMF_ERROR_NOT_FOUND\fR\fR
  60 .ad
  61 .RS 26n
  62 The ID specified for \fIlogicalUnit\fR was not found in the system.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBSTMF_ERROR_VE_CONFLICT\fR\fR
  69 .ad
  70 .RS 26n
  71 Adding this view entry is in conflict with one or more existing view entries.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  78 .ad
  79 .RS 26n
  80 The API call was successful.
  81 .RE
  82
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 Interface Stability     Committed
  97 _
  98 MT-Level        Safe
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)
 105 .SH NOTES
 106 .sp
 107 .LP
 108 If \fIluNbrValid\fR in the \fBstmfViewEntry\fR structure is set to
 109 \fBB_FALSE\fR, the framework will assign a logical unit number for this view
 110 entry. \fIveIndexValid\fR must be set to \fBB_FALSE\fR when adding a view
 111 entry. On successful return, \fIveIndexValid\fR will be set to \fBB_TRUE\fR and
 112 \fIveIndex\fR will contain the view entry index assigned to this view entry by
 113 the framework.