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