Current File : //usr/man/man3zonestat/zs_property.3zonestat

'\" te
.\" Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights    reserved.
.TH zs_property 3ZONESTAT "21 May 2015" "SunOS 5.11" "Zones Statistics Library Functions"
.SH NAME
zs_property, zs_property_type, zs_property_string, zs_property_double, zs_property_uint64, zs_property_int64, zs_property_uint, zs_property_int \- libzonestat property value accessor methods
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR ... ] \fIfile\fR... -lzonestat [ \fIlibary\fR ... ]
#include <zonestat.h>

data_type_t zs_property_type(zs_property_t \fIproperty\fR);
.fi

.LP
.nf
char *zs_property_string(zs_property_t \fIproperty\fR);
.fi

.LP
.nf
double zs_property_double(zs_property_t \fIproperty\fR);
.fi

.LP
.nf
uint64_t zs_property_uint64(zs_property_t \fIproperty\fR);
.fi

.LP
.nf
int64_t zs_property_int64(zs_property_t \fIproperty\fR);
.fi

.LP
.nf
uint_t zs_property_uint(zs_property_t \fIproperty\fR);
.fi

.LP
.nf
int zs_property_int(zs_property_t \fIproperty\fR);
.fi

.SH DESCRIPTION
.sp
.LP
These functions retrieve the values from \fBzs_property_t\fR objects.
.sp
.LP
The \fBzs_property_type()\fR function returns a value from the \fBdata_type_t\fR enumeration defined in \fB<sys/nvpair.h>\fR, which is one of:
.sp

.sp
.TS
tab();
cw(2.75i) cw(2.75i) 
lw(2.75i) lw(2.75i) 
.
ValueDatatype
\fBDATA_TYPE_STRING\fR\fBchar *\fR
\fBDATA_TYPE_UINT64\fR\fBuint64_t\fR
\fBDATA_TYPE_INT64\fR\fBint64_t\fR
\fBDATA_TYPE_UINT32\fR\fBuint_t\fR
\fBDATA_TYPE_INT32\fR\fBint\fR
\fBDATA_TYPE_DOUBLE\fR\fBdouble\fR
.TE

.sp
.LP
The \fBzs_property_string()\fR function returns a \fBchar *\fR pointing to a string. Callers must copy this string in order to retain it after freeing the \fBzs_usage_t\fR object from which this property was obtained.
.sp
.LP
The \fBzs_property_uint64()\fR, \fBzs_property_int64()\fR, \fBzs_property_uint()\fR, \fBzs_property_int()\fR, and \fBzs_property_double()\fR functions return the value contained in the property object.
.SH RETURN VALUES
.sp
.LP
See Description.
.SH ERRORS
.sp
.LP
If a \fBzs_property_*()\fR function is called with a property of the wrong type, the function will abort with \fBabort\fR(3C).
.SH EXAMPLES
.sp
.LP
See \fBzs_pset_zone\fR(3ZONESTAT).
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBzonestat\fR(1), \fBpooladm\fR(1M), \fBpsrset\fR(1M), \fBrcapadm\fR(1M), \fBswap\fR(1M), \fBzoneadm\fR(1M), \fBzonestatd\fR(1M), \fBabort\fR(3C), \fBlibpool\fR(3LIB), \fBlibzonestat\fR(3LIB), \fBzs_pset\fR(3ZONESTAT), \fBzs_open\fR(3ZONESTAT), \fBzs_pset_zone\fR(3ZONESTAT), \fBzs_resource\fR(3ZONESTAT), \fBzs_usage\fR(3ZONESTAT), \fBzs_zone\fR(3ZONESTAT), \fBattributes\fR(5), \fBresource-controls \fR(5)