xref: /illumos-gate/usr/src/man/man3volmgt/volmgt_inuse.3volmgt (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
te
Copyright (c) 1995, 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_INUSE 3VOLMGT "Mar 8, 2007"
NAME
volmgt_inuse - check whether or not volume management is managing a pathname
SYNOPSIS

cc [ flag... ] file... -lvolmgt [ library ... ]
#include <volmgt.h>

int volmgt_inuse(char *pathname);
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(7). The return value of this function is undefined.

volmgt_inuse() checks whether volume management is managing the specified pathname.

RETURN VALUES

The return from this function is undefined.

ERRORS

This routine can fail, returning 0, if a stat(2) of the supplied pathname or an open(2) of /dev/volctl fails, or if any of the following is true: ENXIO

Volume management is not running.

EINTR

An interrupt signal was detected while checking for the supplied pathname for use.

EXAMPLES

Example 1 Using volmgt_inuse()

To see if volume management is managing the first floppy disk:

if (volmgt_inuse("/dev/rdiskette0") != 0) {
 (void) printf("volmgt is managing diskette 0\en");
} else {
 (void) printf("volmgt is NOT managing diskette 0\en");
}
ATTRIBUTES

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

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

open(2), stat(2), errno(3C), volmgt_check(3VOLMGT), volmgt_running(3VOLMGT), attributes(7), hal(7)

NOTES

This routine requires volume management to be running.

Since volmgt_inuse() returns 0 for two different cases (both when a volume is not in use, and when an error occurs), it is up to the user to to check errno to differentiate the two, and to ensure that volume management is running.