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