usr/src/man/man3volmgt/volmgt_feature_enabled.3volmgt

   1 '\" te
   2 .\"  Copyright (c) 1996, 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_FEATURE_ENABLED 3VOLMGT "Mar 8, 2007"
   7 .SH NAME
   8 volmgt_feature_enabled \- check whether specific Volume Management features are
   9 enabled
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-l\fR volmgt [ \fIlibrary\fR ... ]
  14 #include <volmgt.h>
  15
  16
  17
  18 \fBint\fR \fBvolmgt_feature_enabled\fR(\fBchar *\fR\fIfeat_str\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 The  \fBvolmgt_feature_enabled()\fR routine checks whether specific volume
  32 management features are enabled. \fBvolmgt_feature_enabled()\fR checks for the
  33 volume management features passed in to it by the  \fIfeat_str\fR parameter.
  34 .sp
  35 .LP
  36 Currently, the only supported feature string  that
  37 \fBvolmgt_feature_enabled()\fR checks for is \fBfloppy-summit-interfaces\fR.
  38 The  \fBfloppy-summit-interfaces\fR feature string checks for the presence of
  39 the \fBlibvolmgt\fR routines \fBvolmgt_acquire()\fR and \fBvolmgt_release()\fR.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 The return from this function is undefined.
  44 .SH EXAMPLES
  45 .LP
  46 \fBExample 1 \fRA sample of the \fBvolmgt_feature_enabled()\fR function.
  47 .sp
  48 .LP
  49 In the following example,  \fBvolmgt_feature_enabled()\fR checks whether the
  50 \fBfloppy-summit-interfaces\fR feature is enabled.
  51
  52 .sp
  53 .in +2
  54 .nf
  55 if (volmgt_feature_enabled("floppy-summit-interfaces")) {
  56         (void) printf("Media Sharing Routines ARE present\en");
  57 } else {
  58         (void) printf("Media Sharing Routines are NOT present\en");
  59 }
  60 .fi
  61 .in -2
  62
  63 .SH ATTRIBUTES
  64 .sp
  65 .LP
  66 See \fBattributes\fR(5) for descriptions of the following attributes:
  67 .sp
  68
  69 .sp
  70 .TS
  71 box;
  72 c | c
  73 l | l .
  74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  75 _
  76 MT-Level        MT-Safe
  77 _
  78 Interface Stability     Obsolete
  79 .TE
  80
  81 .SH SEE ALSO
  82 .sp
  83 .LP
  84 \fBvolmgt_acquire\fR(3VOLMGT), \fBvolmgt_release\fR(3VOLMGT),
  85 \fBattributes\fR(5), \fBhal\fR(5)