opensolaris man page for volmgt_root

volmgt_root(3VOLMGT)					Volume Management Library Functions				      volmgt_root(3VOLMGT)

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 soft-
       ware 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
", path);
	 } else {
		 (void) printf("can't find Volume Management root dir
");
	 }

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
       cc(1B), 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.

SunOS 5.11							    8 Mar 2007						      volmgt_root(3VOLMGT)