usr/src/man/man3volmgt/volmgt_ownspath.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 VOLMGT_OWNSPATH 3VOLMGT "Mar 8, 2007"
   7 .SH NAME
   8 volmgt_ownspath \- check volume management name space for path
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [flag]\&.\|.\|. \fIfile\fR\&.\|.\|. \fB\(mil\fRvolgmt [library]\&.\|.\|.
  13 #include <volmgt.h>
  14
  15 \fBint\fR \fBvolmgt_ownspath\fR(\fBchar *\fR\fIpath\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIpath\fR\fR
  23 .ad
  24 .RS 8n
  25 A string containing the path.
  26 .RE
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 This function is obsolete. The management of removable media by the Volume
  32 Management feature, including \fBvold\fR, has been replaced by software that
  33 supports the Hardware Abstraction Layer (HAL). Programmatic support for HAL is
  34 through the HAL APIs, which are documented on the HAL web site. See
  35 \fBhal\fR(5). The return value of this function is undefined.
  36 .sp
  37 .LP
  38 The \fBvolmgt_ownspath()\fR function checks to see if a given \fIpath\fR is
  39 contained in the volume management name space. This is achieved by comparing
  40 the beginning of the supplied path name with the output from
  41 \fBvolmgt_root\fR(3VOLMGT)
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 The return from this function is undefined.
  46 .SH EXAMPLES
  47 .LP
  48 \fBExample 1 \fRUsing \fBvolmgt_ownspath()\fR
  49 .sp
  50 .LP
  51 The following example first checks if volume management is running, then checks
  52 the volume management name space for \fIpath\fR, and then returns the \fIid\fR
  53 for the piece of media.
  54
  55 .sp
  56 .in +2
  57 .nf
  58 char *path;
  59
  60 \&...
  61
  62 if (volmgt_running()) {
  63      if (volmgt_ownspath(path)) {
  64           (void) printf("id of %s is %lld\en",
  65                path, media_getid(path));
  66      }
  67 }
  68 .fi
  69 .in -2
  70
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5)  for descriptions of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 MT-Level        Safe
  85 _
  86 Interface Stability     Obsolete
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBvolmgt_root\fR(3VOLMGT), \fBvolmgt_running\fR(3VOLMGT), \fBattributes\fR(5),
  93 \fBhal\fR(5)