te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
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 usr/src/OPENSOLARIS.LICENSE 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 usr/src/OPENSOLARIS.LICENSE. 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]
scf_snaplevel_create, scf_snaplevel_handle, scf_snaplevel_destroy, scf_snaplevel_get_parent, scf_snaplevel_get_scope_name, scf_snaplevel_get_service_name, scf_snaplevel_get_instance_name, scf_snapshot_get_base_snaplevel, scf_snaplevel_get_next_snaplevel - create and manipulate snaplevel handles in the Service Configuration Facility

cc [ flag.\|.\|. ] file.\|.\|. -lscf [ library.\|.\|. ]
#include <libscf.h>

scf_snaplevel_t *scf_snaplevel_create(scf_handle_t *handle);

scf_handle_t *scf_snaplevel_handle(scf_snaplevel_t *level);

void scf_snaplevel_destroy(scf_snaplevel_t *level);

int scf_snaplevel_get_parent(const scf_snaplevel_t *level,
 const scf_snapshot_t *snap);

ssize_t scf_snaplevel_get_scope_name(const scf_snaplevel_t *level,
 char *buf, size_t size);

ssize_t scf_snaplevel_get_service_name(const scf_snaplevel_t *level,
 char *buf, size_t size);

ssize_t scf_snaplevel_get_instance_name(const scf_snaplevel_t *level,
 char *buf, size_t size);

int scf_snapshot_get_base_snaplevel(const scf_snapshot_t *snap,
 scf_snaplevel_t *level);

int scf_snaplevel_get_next_snaplevel(scf_snaplevel_t *in,
 scf_snaplevel_t *out);

A snaplevel holds all of the property groups associated with either a service or an instance. Each snapshot has an ordered list of snaplevels. Snaplevels contain the names of the instance or service from which they are derived.

An scf_snaplevel_t is an opaque handle that can be set to a single snaplevel at any given time. When set, the scf_snaplevel_t inherits the point in time from the scf_snapshot_t from which it comes.

The scf_snaplevel_create() function allocates and initializes a new scf_snaplevel_t bound to handle. The scf_snaplevel_destroy() function destroys and frees level.

The scf_snaplevel_handle() function retrieves the handle to which level is bound.

The scf_snaplevel_get_parent() function sets snap to the parent snapshot of the snaplevel to which level is set. The snapshot specified by snap is attached to the same point in time as level.

The scf_snaplevel_get_scope_name(), scf_snaplevel_get_service_name(), and scf_snaplevel_get_instance_name() functions retrieve the name of the scope, service, and instance for the snapshot to which snap is set. If the snaplevel is from an instance, all three succeed. If the snaplevel is from a service, scf_snaplevel_get_instance_name() fails.

The scf_snapshot_get_base_snaplevel() function sets level to the first snaplevel in the snapshot to which snap is set. The scf_snaplevel_get_next_snaplevel() function sets out to the next snaplevel after the snaplevel to which in is set. Both the in and out arguments can point to the same scf_snaplevel_t.

To retrieve the property groups associated with a snaplevel, see scf_iter_snaplevel_pgs(3SCF), scf_iter_snaplevel_pgs_typed(3SCF), and scf_snaplevel_get_pg(3SCF).

Upon successful completion, scf_snaplevel_create() returns a new scf_snaplevel_t. Otherwise, it returns NULL.

Upon successful completion, scf_snaplevel_get_scope_name(), scf_snaplevel_get_service_name(), and scf_snaplevel_get_instance_name() return the length of the string written, not including the terminating null byte. Otherwise, they return -1.

Upon successful completion, scf_snaplevel_get_parent(), scf_snapshot_get_base_snaplevel(), and scf_snaplevel_get_next_snaplevel() return. Otherwise, they return -1.

The scf_snaplevel_create() function will fail if: SCF_ERROR_INVALID_ARGUMENT

SCF_ERROR_NO_MEMORY SCF_ERROR_NO_RESOURCES

The scf_snaplevel_get_scope_name(), scf_snaplevel_get_service_name(), scf_snaplevel_get_instance_name(), and scf_snaplevel_get_parent() functions will fail if: SCF_ERROR_DELETED

SCF_ERROR_NOT_SET SCF_ERROR_NOT_BOUND SCF_ERROR_CONNECTION_BROKEN

The scf_snaplevel_get_instance_name() function will fail if: SCF_ERROR_CONSTRAINT_VIOLATED

The scf_snapshot_get_base_snaplevel() function will fail if: SCF_ERROR_CONNECTION_BROKEN

SCF_ERROR_DELETED SCF_ERROR_HANDLE_MISMATCH SCF_ERROR_NO_RESOURCES SCF_ERROR_NOT_BOUND SCF_ERROR_NOT_FOUND SCF_ERROR_NOT_SET

The scf_snaplevel_get_next_snaplevel() function will fail if: SCF_ERROR_DELETED

SCF_ERROR_NOT_SET SCF_ERROR_HANDLE_MISMATCH SCF_ERROR_NOT_BOUND SCF_ERROR_CONNECTION_BROKEN SCF_ERROR_NOT_FOUND

The scf_error(3SCF) function can be used to retrieve the error value.

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

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Committed

MT-Level Safe

libscf(3LIB), scf_error(3SCF), scf_iter_snaplevel_pgs(3SCF), scf_iter_snaplevel_pgs_typed(3SCF), scf_snaplevel_get_pg(3SCF), attributes(5)