usr/src/man/man3volmgt/volmgt_root.3volmgt

   1 '\" te
   2 .\"  Copyright (c) 2001, 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_ROOT 3VOLMGT "Mar 8, 2007"
   7 .SH NAME
   8 volmgt_root \- return the volume management root directory
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lvolmgt\fR [ \fIlibrary\fR ... ]
  13 #include <volmgt.h>
  14 \fBconst char *\fR\fBvolmgt_root\fR(\fBvoid\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 This function is obsolete. The management of removable media by the Volume
  21 Management feature, including \fBvold\fR, has been replaced by software that
  22 supports the Hardware Abstraction Layer (HAL). Programmatic support for HAL is
  23 through the HAL APIs, which are documented on the HAL web site. See
  24 \fBhal\fR(5). The return value of this function is undefined.
  25 .sp
  26 .LP
  27 The \fBvolmgt_root()\fR function returns the current volume management root
  28 directory, which by default is \fB/vol\fR but can be configured to be in a
  29 different location.
  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 function may fail if an \fBopen()\fR of \fB/dev/volctl\fR fails.  If this
  38 occurs a pointer to the default Volume Management root directory is returned.
  39 .SH EXAMPLES
  40 .LP
  41 \fBExample 1 \fRFinding the Volume Management Root directory.
  42 .sp
  43 .LP
  44 To find out where the volume management root directory is:
  45
  46 .sp
  47 .in +2
  48 .nf
  49 if ((path = volmgt_root()) != NULL) {
  50         (void) printf("Volume Management root dir=%s\en", path);
  51 } else {
  52         (void) printf("can't find Volume Management root dir\en");
  53 }
  54 .fi
  55 .in -2
  56
  57 .SH FILES
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fB/dev\fR\fR
  62 .ad
  63 .RS 8n
  64 default location for the volume management root directory
  65 .RE
  66
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 MT-Level        MT-Safe
  81 _
  82 Interface Stability     Obsolete
  83 .TE
  84
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBopen\fR(2), \fBvolmgt_check\fR(3VOLMGT), \fBvolmgt_inuse\fR(3VOLMGT),
  89 \fBvolmgt_running\fR(3VOLMGT), \fBattributes\fR(5), \fBhal\fR(5)
  90 .SH NOTES
  91 .sp
  92 .LP
  93 This function returns the default root directory location even when volume
  94 management is not running.