scha_cluster_getzone(3HA)

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:

0

The function succeeded.

nonzero

The function failed.

Errors

SCHA_ERR_NOERR

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

/usr/cluster/include/scha.h

Include file

/usr/cluster/lib/libscha.so

Library

Attributes

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

ATTRIBUTE TYPE ATTRIBUTE VALUE Availability ha-cluster/developer/api Interface Stability Evolving

See also

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