xref: /illumos-gate/usr/src/man/man3volmgt/volmgt_root.3volmgt (revision d0b3c59ba652f183eeec1414dd9fbdc56bf05cc8)
te
Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved
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. 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. 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]
VOLMGT_ROOT 3VOLMGT "Mar 8, 2007"
NAME
volmgt_root - return the volume management root directory
SYNOPSIS

cc [ flag... ] file... -lvolmgt [ library ... ]
#include <volmgt.h>
const char *volmgt_root(void);
DESCRIPTION

This function is obsolete. The management of removable media by the Volume Management feature, including vold, has been replaced by software that supports the Hardware Abstraction Layer (HAL). Programmatic support for HAL is through the HAL APIs, which are documented on the HAL web site. See hal(5). The return value of this function is undefined.

The volmgt_root() function returns the current volume management root directory, which by default is /vol but can be configured to be in a different location.

RETURN VALUES

The return from this function is undefined.

ERRORS

This function may fail if an open() of /dev/volctl fails. If this occurs a pointer to the default Volume Management root directory is returned.

EXAMPLES

Example 1 Finding the Volume Management Root directory.

To find out where the volume management root directory is:

if ((path = volmgt_root()) != NULL) {
 (void) printf("Volume Management root dir=%s\en", path);
} else {
 (void) printf("can't find Volume Management root dir\en");
}
FILES
/dev

default location for the volume management root directory

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe
Interface Stability Obsolete
SEE ALSO

open(2), volmgt_check(3VOLMGT), volmgt_inuse(3VOLMGT), volmgt_running(3VOLMGT), attributes(5), hal(5)

NOTES

This function returns the default root directory location even when volume management is not running.