share/man/man3volmgt/volmgt_inuse.3volmgt

   1 '\" te
   2 .\"  Copyright (c) 1995, 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 VOLMGT_INUSE 3VOLMGT "Mar 8, 2007"
   7 .SH NAME
   8 volmgt_inuse \- check whether or not volume management is managing a pathname
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lvolmgt\fR [ \fIlibrary\fR ... ]
  13 #include <volmgt.h>
  14
  15 \fBint\fR \fBvolmgt_inuse\fR(\fBchar *\fR\fIpathname\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 This function is obsolete. The management of removable media by the Volume
  22 Management feature, including \fBvold\fR, has been replaced by software that
  23 supports the Hardware Abstraction Layer (HAL). Programmatic support for HAL is
  24 through the HAL APIs, which are documented on the HAL web site. See
  25 \fBhal\fR(5). The return value of this function is undefined.
  26 .sp
  27 .LP
  28 \fBvolmgt_inuse()\fR checks whether volume management is managing the specified
  29 \fIpathname\fR.
  30 .SH RETURN VALUES
  31 .sp
  32 .LP
  33 The return from this function is undefined.
  34 .SH ERRORS
  35 .sp
  36 .LP
  37 This routine can fail, returning \fB0\fR, if a \fBstat\fR(2) of the supplied
  38 \fIpathname\fR or an \fBopen\fR(2) of \fB/dev/volctl\fR fails, or if any of the
  39 following is true:
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBENXIO\fR\fR
  44 .ad
  45 .RS 9n
  46 Volume management is not running.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBEINTR\fR\fR
  53 .ad
  54 .RS 9n
  55 An interrupt signal was detected while checking for the supplied \fIpathname\fR
  56 for use.
  57 .RE
  58
  59 .SH EXAMPLES
  60 .LP
  61 \fBExample 1 \fRUsing \fBvolmgt_inuse()\fR
  62 .sp
  63 .LP
  64 To see if volume management is managing the first floppy disk:
  65
  66 .sp
  67 .in +2
  68 .nf
  69 if (volmgt_inuse("/dev/rdiskette0") != 0) {
  70         (void) printf("volmgt is managing diskette 0\en");
  71 } else {
  72         (void) printf("volmgt is NOT managing diskette 0\en");
  73 }
  74 .fi
  75 .in -2
  76
  77 .SH ATTRIBUTES
  78 .sp
  79 .LP
  80 See \fBattributes\fR(5) for descriptions of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 box;
  86 c | c
  87 l | l .
  88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  89 _
  90 MT-Level        MT-Safe
  91 _
  92 Interface Stability     Obsolete
  93 .TE
  94
  95 .SH SEE ALSO
  96 .sp
  97 .LP
  98 \fBopen\fR(2),  \fBstat\fR(2),  \fBerrno\fR(3C),  \fBvolmgt_check\fR(3VOLMGT),
  99 \fBvolmgt_running\fR(3VOLMGT),  \fBattributes\fR(5),  \fBhal\fR(5)
 100 .SH NOTES
 101 .sp
 102 .LP
 103 This routine requires volume management to be running.
 104 .sp
 105 .LP
 106 Since \fBvolmgt_inuse()\fR returns \fB0\fR for two different cases (both when a
 107 volume is not in use, and when an error occurs), it is up to the user to to
 108 check \fBerrno\fR to differentiate the two, and to ensure that volume
 109 management is running.