share/man/man3volmgt/media_getid.3volmgt

   1 '\" te
   2 .\" Copyright (c) 1998, 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.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH MEDIA_GETID 3VOLMGT "Mar 8, 2007"
   7 .SH NAME
   8 media_getid \- return the id of a piece of media
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc \fR[flag \&.\|.\|.] \fIfile \fR\&.\|.\|.\fB\(mil\fRvolgmt [library \&.\|.\|.]
  13
  14 #include <volmgt.h>
  15
  16
  17
  18 \fBulonglong_t\fR \fBmedia_getid\fR(\fBchar *\fR\fIvol_path\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 This function is obsolete. The management of removable media by the Volume
  25 Management feature, including \fBvold\fR, has been replaced by software that
  26 supports the Hardware Abstraction Layer (HAL). Programmatic support for HAL is
  27 through the HAL APIs, which are documented on the HAL web site. See
  28 \fBhal\fR(5). The return value of this function is undefined.
  29 .sp
  30 .LP
  31 \fBmedia_getid()\fR returns the \fIid\fR of a piece of media. Volume management
  32 must be running. See \fBvolmgt_running\fR(3VOLMGT).
  33 .SH PARAMETERS
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIvol_path\fR\fR
  38 .ad
  39 .RS 12n
  40 Path to the block or character special device.
  41 .RE
  42
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 The return from this function is undefined.
  47 .SH EXAMPLES
  48 .LP
  49 \fBExample 1 \fRUsing \fBmedia_getid()\fR
  50 .sp
  51 .LP
  52 The following example first checks if volume management is running, then checks
  53 the volume management name space for \fIpath\fR, and then returns the \fIid\fR
  54 for the piece of media.
  55
  56 .sp
  57 .in +2
  58 .nf
  59 char *path;
  60
  61         ...
  62
  63 if (volmgt_running()) {
  64      if (volmgt_ownspath(path)) {
  65           (void) printf("id of %s is %lld\en",
  66                path, media_getid(path));
  67      }
  68         }
  69 .fi
  70 .in -2
  71
  72 .sp
  73 .LP
  74 If a program using \fBmedia_getid()\fR does not check whether or not volume
  75 management is running, then any \fBNULL\fR return value will be ambiguous, as
  76 it could mean that either volume management does not have \fIpath\fR in its
  77 name space, or volume management is not running.
  78
  79 .SH ATTRIBUTES
  80 .sp
  81 .LP
  82 See \fBattributes\fR(5)  for descriptions of the following attributes:
  83 .sp
  84
  85 .sp
  86 .TS
  87 box;
  88 c | c
  89 l | l .
  90 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  91 _
  92 MT-Level        Safe
  93 _
  94 Interface Stability     Obsolete
  95 .TE
  96
  97 .SH SEE ALSO
  98 .sp
  99 .LP
 100 \fBvolmgt_ownspath\fR(3VOLMGT), \fBvolmgt_running\fR(3VOLMGT),
 101 \fBattributes\fR(5), \fBhal\fR(5)