man pages section 3: Basic Library Functions

Exit Print View

Updated: July 2014
 
 

getzoneidbyname(3C)

Name

getzoneid, getzoneidbyname, getzonenamebyid - map between zone id and name

Synopsis

#include <zone.h>

zoneid_t getzoneid(void);
zoneid_t getzoneidbyname(
const char *name);
ssize_t getzonenamebyid(
zoneid_t id, char *
buf, size_t buflen);

Description

The getzoneid() function returns the zone ID of the calling process.

The getzoneidbyname() function returns the zone ID corresponding to the named zone, if that zone is currently active. If name is NULL, the function returns the zone ID of the calling process.

The getzonenamebyid() function stores the name of the zone with ID specified by id in the location specified by buf. The bufsize argument specifies the size in bytes of the buffer. If the buffer is too small to hold the complete null-terminated name, the first bufsize bytes of the name are stored in the buffer. A buffer of size {ZONENAME_MAX} is sufficient to hold any zone name. If buf is NULL or bufsize is 0, the name is not copied into the buffer.

From a solaris-kz brand zone, the returned ID will be 0, equivalent to a global zone, rather than the ID visible from the host global zone.

Return Values

On successful completion, getzoneid() and getzoneidbyname() return a non-negative zone ID. Otherwise, getzoneidbyname() returns −1 and sets errno to indicate the error.

On successful completion, the getzonenamebyid() function returns the buffer size required to hold the full null-terminated name. Otherwise, it returns −1 and sets errno to indicate the error.

Errors

The getzoneidbyname() function will fail if:

EFAULT

The name argument is non-null and points to an illegal address.

EINVAL

A zone with the indicated name is not active.

ENAMETOOLONG

The length of the name argument exceeds {ZONENAME_MAX}.

The getzonenamebyid() function will fail if:

EINVAL

A zone with the specified ID is not active.

EFAULT

The buf argument points to an illegal address.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See Also

Intro(2), chroot(2) , malloc(3C), attributes (5), zones(5)