usr/src/man/man3stmf/stmfRemoveViewEntry.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 STMFREMOVEVIEWENTRY 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfRemoveViewEntry \- remove a view entry from the system
   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 \fBstmfRemoveViewEntry\fR(\fBstmfGuid *\fR\fIlogicalUnit\fR,
  16      \fBuint32_t\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 for the view entry being removed.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIviewEntry\fR\fR
  33 .ad
  34 .RS 15n
  35 The numeric value of the view entry to be removed.
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBstmfRemoveViewEntry()\fR function removes a view entry from the system.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 The following values are returned:
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBSTMF_ERROR_NOT_FOUND\fR\fR
  50 .ad
  51 .RS 24n
  52 The specified \fIlogicalUnit\fR or \fIviewEntryName\fR was not found in the
  53 system.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  60 .ad
  61 .RS 24n
  62 The API call was successful.
  63 .RE
  64
  65 .SH ATTRIBUTES
  66 .sp
  67 .LP
  68 See \fBattributes\fR(5) for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 Interface Stability     Committed
  79 _
  80 MT-Level        Safe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)