usr/src/man/man3volmgt/volmgt_running.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_RUNNING 3VOLMGT "Mar 8, 2007"
   7 .SH NAME
   8 volmgt_running \- return whether or not volume management is running
   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_running\fR(\fBvoid\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).
  26 .sp
  27 .LP
  28 \fBvolmgt_running()\fR tells whether or not Volume Management is running.
  29 .SH RETURN VALUES
  30 .sp
  31 .LP
  32 \fBvolmgt_running()\fR always returns \fB0\fR indicating Volume Management (as
  33 implemented by \fBvold\fR) is not running.
  34 .SH ERRORS
  35 .sp
  36 .LP
  37 \fBvolmgt_running()\fR will fail, returning \fB0\fR, if a \fBstat\fR(2) or
  38 \fBopen\fR(2) of \fB/dev/volctl\fR fails, or if any of the following is true:
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBENXIO\fR\fR
  43 .ad
  44 .RS 9n
  45 Volume Management is not running.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBEINTR\fR\fR
  52 .ad
  53 .RS 9n
  54 An interrupt signal was detected while checking to see if Volume Management was
  55 running.
  56 .RE
  57
  58 .SH EXAMPLES
  59 .LP
  60 \fBExample 1 \fRUsing \fBvolmgt_running()\fR
  61 .sp
  62 .LP
  63 To see if Volume Management is running:
  64
  65 .sp
  66 .in +2
  67 .nf
  68 \fBif (volmgt_running() != 0) {
  69         (void) printf("Volume Management is running\en");
  70 } else {
  71         (void) printf("Volume Management is NOT running\en");
  72 }\fR
  73 .fi
  74 .in -2
  75
  76 .SH ATTRIBUTES
  77 .sp
  78 .LP
  79 See \fBattributes\fR(5) for descriptions of the following attributes:
  80 .sp
  81
  82 .sp
  83 .TS
  84 box;
  85 c | c
  86 l | l .
  87 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  88 _
  89 MT-Level        MT-Safe
  90 _
  91 Interface Stability     Obsolete
  92 .TE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBopen\fR(2), \fBstat\fR(2), \fBvolmgt_check\fR(3VOLMGT),
  98 \fBvolmgt_inuse\fR(3VOLMGT), \fBattributes\fR(5), \fBhal\fR(5)
  99 .SH NOTES
 100 .sp
 101 .LP
 102 Volume Management must be running for many of the Volume Management library
 103 routines to work.