usr/src/man/man3stmf/stmfFreeLuResource.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 STMFFREELURESOURCE 3STMF "May 8, 2009"
   7 .SH NAME
   8 stmfFreeLuResource \- free an allocated logical unit resource
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... -lstmf [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfFreeLuResource\fR(\fBluResource\fR \fIhdl\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIhdl\fR\fR
  23 .ad
  24 .RS 7n
  25 A logical unit resource previously allocated in a call to
  26 \fBstmfCreateLuResource\fR(3STMF) or \fBstmfGetLuResource\fR(3STMF).
  27 .RE
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBstmfFreeLuResource()\fR function frees a logical unit resource that was
  33 previously allocated in a call to \fBstmfCreateLuResource\fR(3STMF) or
  34 \fBstmfGetLuResource\fR(3STMF).
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 The following values are returned:
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  43 .ad
  44 .RS 26n
  45 The API call was successful.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBSTMF_ERROR_INVALID_ARG\fR\fR
  52 .ad
  53 .RS 26n
  54 The \fIhdl\fR argument is not a valid logical unit resource.
  55 .RE
  56
  57 .SH ATTRIBUTES
  58 .sp
  59 .LP
  60 See \fBattributes\fR(5) for descriptions of the following attributes:
  61 .sp
  62
  63 .sp
  64 .TS
  65 box;
  66 c | c
  67 l | l .
  68 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  69 _
  70 Interface Stability     Committed
  71 _
  72 MT-Level        Safe
  73 .TE
  74
  75 .SH SEE ALSO
  76 .sp
  77 .LP
  78 \fBlibstmf\fR(3LIB), \fBstmfCreateLuResource\fR(3STMF),
  79 \fBstmfGetLuResource\fR(3STMF), \fBattributes\fR(5)