usr/src/man/man3stmf/stmfGetViewEntryList.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 STMFGETVIEWENTRYLIST 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfGetViewEntryList \- retrieve the list of view entries for a 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 \fBstmfGetViewEntryList\fR(\fBstmfGuid *\fR\fIlogicalUnit\fR,
  17      \fBstmfViewEntryList **\fR\fIviewEntryList\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIlogicalUnit\fR\fR
  25 .ad
  26 .RS 17n
  27 The identifier of the logical unit for which to retrieve the list of view
  28 entries.
  29 .RE
  30
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIviewEntryList\fR\fR
  35 .ad
  36 .RS 17n
  37 A pointer to a pointer to an \fBstmfViewEntryList\fR structure. On successful
  38 return, this will contain a list of view entries for \fIlogicalUnit\fR.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBstmfGetViewEntryList()\fR function retrieves the list of view entries
  45 for a specified logical unit. The caller should call
  46 \fBstmfFreeMemory\fR(3STMF) when this list is no longer needed.
  47 .SH RETURN VALUES
  48 .sp
  49 .LP
  50 The following values are returned:
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBSTMF_ERROR_NOMEM\fR\fR
  55 .ad
  56 .RS 23n
  57 The library was unable to allocate sufficient memory for \fIviewEntryList\fR.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  64 .ad
  65 .RS 23n
  66 The API call was successful.
  67 .RE
  68
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 Interface Stability     Committed
  83 _
  84 MT-Level        Safe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBlibstmf\fR(3LIB), \fBstmfFreeMemory\fR(3STMF), \fBattributes\fR(5)