opensolaris man page for scds_get_zone_name

scds_get_zone_name(3HA) 				 Sun Cluster HA and Data Services				   scds_get_zone_name(3HA)

NAME
       scds_get_zone_name - retrieve the name of a zone on whose behalf a method is running

SYNOPSIS
       cc [flags...] -I /usr/cluster/include file -L /usr/cluster/lib  -l  dsdev
       #include <rgm/libdsdev.h>

       const char *scds_get_zone_name(scds_handle_t handle

DESCRIPTION
       The  scds_get_zone_name() function returns a pointer to a character string. If the following conditions are met, this character string con-
       tains the name of the zone in which a resource group runs:

	   o	  The Global_zone resource type property is set to TRUE.

		  See the rt_properties(5) man page for information about the Global_zone resource type property.

	   o	  The method is configured to run in a non-global zone.

       In all other cases, including the following, the character string is NULL:

	   o	  Sun Cluster software is running on an operating system that does not support zones.

	   o	  The resource group and the method are running in the global zone.

	   o	  The Global_zone resource type property is set to FALSE.

       To obtain the name of the zone in which a method is actually executing, use the zonename command. See the zonename(1) man page.

       The pointer to the character string points to memory that belongs to the Data Service Development Library (DSDL). Do not modify	this  mem-
       ory. A call to scds_close() invalidates this pointer.

PARAMETERS
       The following parameters are supported:

       handle		   The handle that is returned from scds_initialize(3HA).

ERRORS
       SCHA_ERR_NOERR		   The function succeeded.

       See  scha_calls(3HA) for a description of other error codes.

FILES
       /usr/cluster/include/rgm/libdsdev.h

	   Include file

       /usr/cluster/lib/libdsdev.so

	   Library

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWscdev 		   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       zonename(1), scds_close(3HA), scds_initialize(3HA), scha_calls(3HA), attributes(5), rt_properties(5)

Sun Cluster 3.2 						    7 Sep 2007						   scds_get_zone_name(3HA)