xref: /illumos-gate/usr/src/man/man3volmgt/volmgt_check.3volmgt (revision 6a817834d81cc75ce12d0d393320837b1fec1e85)
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_CHECK 3VOLMGT "Mar 8, 2007"
NAME
volmgt_check - have Volume Management check for media
SYNOPSIS

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

int volmgt_check(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(5). The return value of this function is undefined.

This routine asks volume Management to check the specified pathname and determine if new media has been inserted in that drive.

If a null pointer is passed in, then Volume Management will check each device it is managing that can be checked.

If new media is found, volmgt_check() tells volume management to initiate appropriate actions.

RETURN VALUES

The return from this function is undefined.

ERRORS

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

volume management is not running.

EINTR

An interrupt signal was detected while checking for media.

EXAMPLES

Example 1 Checking If Any New Media Is Inserted

To check if any drive managed by volume management has any new media inserted in it:

if (volmgt_check(NULL)) {
 (void) printf("Volume management found media\en");
}

This would also request volume management to take whatever action was appropriate for the new media.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe
SEE ALSO

volcheck(1), open(2), stat(2), volmgt_inuse(3VOLMGT), volmgt_running(3VOLMGT), attributes(5), hal(5)

NOTES

Since volmgt_check() returns 0 for two different cases (both when no media is found, and when an error occurs), it is up to the user to check errno to differentiate the two, and to ensure that volume management is running.