usr/src/man/man3volmgt/volmgt_symname.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_SYMNAME 3VOLMGT "Mar 8, 2007"
   7 .SH NAME
   8 volmgt_symname, volmgt_symdev \- convert between Volume Management symbolic
   9 names, and the devices that correspond to them
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lvolmgt\fR [ \fIlibrary\fR... ]
  14 #include <volmgt.h>
  15
  16 \fBchar *\fR\fBvolmgt_symname\fR(\fBchar *\fR\fIpathname\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBchar *\fR\fBvolmgt_symdev\fR(\fBchar *\fR\fIsymname\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 This function is obsolete. The management of removable media by the Volume
  28 Management feature, including \fBvold\fR, has been replaced by software that
  29 supports the Hardware Abstraction Layer (HAL). Programmatic support for HAL is
  30 through the HAL APIs, which are documented on the HAL web site. See
  31 \fBhal\fR(5). The return value of this function is undefined.
  32 .sp
  33 .LP
  34 These two routines compliment each other, translating between Volume
  35 Management's symbolic name for a device, called a \fIsymname\fR, and the
  36 \fB/dev\fR \fIpathname\fR for that same device.
  37 .sp
  38 .LP
  39 \fBvolmgt_symname\fR(\|) converts a supplied \fB/dev\fR \fIpathname\fR to a
  40 \fBsymname\fR, Volume Management's idea of that device's symbolic name.
  41 .sp
  42 .LP
  43 \fBvolmgt_symdev\fR(\|) does the opposite conversion, converting between a
  44 \fIsymname\fR, Volume Management's idea of a device's symbolic name for a
  45 volume, to the \fB/dev\fR \fIpathname\fR for that device.
  46 .SH RETURN VALUES
  47 .sp
  48 .LP
  49 The return from this function is undefined.
  50 .SH ERRORS
  51 .sp
  52 .LP
  53 \fBvolmgt_symname\fR(\|) can fail, returning a null string pointer, if a
  54 \fBstat\fR(2) of the supplied \fBpathname\fR fails, or if an \fBopen\fR(2) of
  55 \fB/dev/volctl\fR fails, or if any of the following is true:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBENXIO\fR\fR
  60 .ad
  61 .RS 9n
  62 Volume Management is not running.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBEINTR\fR\fR
  69 .ad
  70 .RS 9n
  71 An interrupt signal was detected while trying to convert the supplied
  72 \fIpathname\fR to a \fIsymname\fR.
  73 .RE
  74
  75 .sp
  76 .LP
  77 \fBvolmgt_symdev\fR(\|) can fail if an \fBopen\fR(2) of \fB/dev/volctl\fR
  78 fails, or if any of the following is true:
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBENXIO\fR\fR
  83 .ad
  84 .RS 9n
  85 Volume Management is not running.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBEINTR\fR\fR
  92 .ad
  93 .RS 9n
  94 An interrupt signal was detected while trying to convert the supplied
  95 \fIsymname\fR to a \fB/dev\fR \fIpathname\fR.
  96 .RE
  97
  98 .SH EXAMPLES
  99 .LP
 100 \fBExample 1 \fRTesting Floppies
 101 .sp
 102 .LP
 103 The following tests how many floppies Volume Management currently sees in
 104 floppy drives (up to 10):
 105
 106 .sp
 107 .in +2
 108 .nf
 109 for (i=0; i < 10; i++) {
 110         (void) sprintf(path, "floppy%d", i);
 111         if (volmgt_symdev(path) != NULL) {
 112                 (void) printf("volume %s is in drive %d\en",
 113                     path, i);
 114         }
 115 }
 116 .fi
 117 .in -2
 118
 119 .LP
 120 \fBExample 2 \fRFinding The Symbolic Name
 121 .sp
 122 .LP
 123 This code finds out what symbolic name (if any) Volume Management has for
 124 \fB/dev/rdsk/c0t6d0s2\fR:
 125
 126 .sp
 127 .in +2
 128 .nf
 129 if ((nm = volmgt_symname("/dev/rdsk/c0t6d0s2")) == NULL) {
 130         (void) printf("path not managed\en");
 131 } else {
 132         (void) printf("path managed as %s\en", nm);
 133 }
 134 .fi
 135 .in -2
 136
 137 .SH ATTRIBUTES
 138 .sp
 139 .LP
 140 See \fBattributes\fR(5) for descriptions of the following attributes:
 141 .sp
 142
 143 .sp
 144 .TS
 145 box;
 146 c | c
 147 l | l .
 148 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 149 _
 150 MT-Level        MT-Safe
 151 _
 152 Interface Stability     Obsolete
 153 .TE
 154
 155 .SH SEE ALSO
 156 .sp
 157 .LP
 158 \fBopen\fR(2), \fBstat\fR(2), \fBfree\fR(3C), \fBmalloc\fR(3C),
 159 \fBvolmgt_check\fR(3VOLMGT), \fBvolmgt_inuse\fR(3VOLMGT),
 160 \fBvolmgt_running\fR(3VOLMGT), \fBattributes\fR(5), \fBhal\fR(5)