Home | History | Annotate | Download | only in man3ha
 te
 CDDL HEADER START

 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 CDDL.txt
 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 CDDL.txt.
 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]

 CDDL HEADER END
 Copyright 2007 Sun Microsystems, Inc. All rights
 reserved. Use is subject to license terms.
 scha_cluster_getzone 3HA "7 Sep 2007" "Sun Cluster 3.2" "Sun Cluster HA and Data Services"
 NAME
scha_cluster_getzone - return name of zone

 SYNOPSIS


cc [flags.\|.\|.] -I /usr/cluster/include file -L /usr/cluster/lib  -l  scha
#include <scha.h>

 scha_err_t scha_cluster_getzone(char **zonename);




 DESCRIPTION

The scha_cluster_getzone() function returns a string
that identifies the zone from which the function is called. If you call this
function in a non-global zone, the zone name and the node name are returned,
in the format nodename:zonename. If you call this function
in the global zone, only the node name is returned. The node name is not necessarily
the same as the Solaris system name. The function returns an error status.
If successful, the function also returns a string that contains the node name
and the zone name in the location that is pointed to by the zonename argument.


If the call fails, the zonename argument
is set to NULL. The caller of scha_cluster_getzone() is
responsible for freeing the memory that is allocated for the returned string
by using the standard C library function free(3C). Freeing the memory is required only if
the function succeeds.

 RETURN VALUES

The scha_cluster_getzone() function returns the following
values:


.na
0
.ad


The function succeeded.





.na
nonzero
.ad


The function failed.




 ERRORS

.na
SCHA_ERR_NOERR 
.ad


The function succeeded.





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

 EXAMPLES

Example 1 Using the scha_cluster_getzone() Function

 scha_err_t err_code;
 char *zonename;
 err_code = scha_cluster_getzone(&zonename);
 ...
 if (zonename != NULL) free(zonename);




 FILES

.na
/usr/cluster/include/scha.h
.ad


Include file





.na
/usr/cluster/lib/libscha.so
.ad


Library




 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWscdev
Interface StabilityEvolving



 SEE ALSO

free(3C), scha_calls(3HA), scha_cluster_get(3HA), scha_cluster_getnodename(3HA), scha_strerror(3HA), attributes(5)