xref: /illumos-gate/usr/src/man/man3volmgt/media_getid.3volmgt (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
te
Copyright (c) 1998, 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]
MEDIA_GETID 3VOLMGT "Mar 8, 2007"
NAME
media_getid - return the id of a piece of media
SYNOPSIS

cc [flag .\|.\|.] file .\|.\|.-lvolmgt [library .\|.\|.]

#include <volmgt.h>



ulonglong_t media_getid(char *vol_path);
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.

media_getid() returns the id of a piece of media. Volume management must be running. See volmgt_running(3VOLMGT).

PARAMETERS
vol_path

Path to the block or character special device.

RETURN VALUES

The return from this function is undefined.

EXAMPLES

Example 1 Using media_getid()

The following example first checks if volume management is running, then checks the volume management name space for path, and then returns the id for the piece of media.

char *path;

 ...

if (volmgt_running()) {
 if (volmgt_ownspath(path)) {
 (void) printf("id of %s is %lld\en",
 path, media_getid(path));
 }
 }

If a program using media_getid() does not check whether or not volume management is running, then any NULL return value will be ambiguous, as it could mean that either volume management does not have path in its name space, or volume management is not running.

ATTRIBUTES

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

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

volmgt_ownspath (3VOLMGT), volmgt_running (3VOLMGT), attributes (7), hal (7)