share/man/man3stmf/stmfDeleteLu.3stmf

   1 '\" te
   2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. 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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH STMFDELETELU 3STMF "May 8, 2009"
   7 .SH NAME
   8 stmfDeleteLu \- delete a logical unit
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... -lstmf [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfDeleteLu\fR(\fBstmfGuid *\fR\fIluGuid\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIluGuid\fR\fR
  23 .ad
  24 .RS 10n
  25 a pointer to an \fBstmfGuid\fR structure containing the guid of the logical
  26 unit to delete
  27 .RE
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBstmfDeleteLu()\fR function deletes the logical unit from the system. Any
  33 view entries that may exist for this logical unit will be retained in the
  34 system and must be removed using \fBstmfRemoveViewEntry\fR(3STMF) if so
  35 desired.
  36 .SH RETURN VALUES
  37 .sp
  38 .LP
  39 The following values are returned:
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  44 .ad
  45 .RS 24n
  46 The API call was successful.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBSTMF_ERROR_NOT_FOUND\fR\fR
  53 .ad
  54 .RS 24n
  55 The guid does not exist.
  56 .RE
  57
  58 .SH ATTRIBUTES
  59 .sp
  60 .LP
  61 See \fBattributes\fR(5) for descriptions of the following attributes:
  62 .sp
  63
  64 .sp
  65 .TS
  66 box;
  67 c | c
  68 l | l .
  69 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  70 _
  71 Interface Stability     Committed
  72 _
  73 MT-Level        Safe
  74 .TE
  75
  76 .SH SEE ALSO
  77 .sp
  78 .LP
  79 \fBlibstmf\fR(3LIB), \fBstmfRemoveViewEntry\fR(3STMF), \fBattributes\fR(5)