scf_service_is_masked

, scf_instance_is_masked

, scf_pg_is_masked

, scf_property_is_masked

- determine whether entities are masked in the Service Configuration Facility

Synopsis

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

int scf_service_is_masked(const scf_service_t *svc);

int scf_instance_is_masked(const scf_instance_t *inst);

int scf_pg_is_masked(const scf_propertygroup_t *pg);

int scf_property_is_masked(const scf_property_t *prop);

Description

Entities are masked if an administrator has requested they be deleted, but the entity is backed by configuration in the filesystem such as manifests and profiles.

Masked entities are not discovered through libscf(3LIB) unless the caller decorates the initial handle with scf_handle_decorate(h, “show_masked”, SCF_DECORATE_TRUE). If the caller needs to ignore masked entities, it must explicitly call one of the functions described on this manual page to determine the entity is masked.

These functions allow consumers to determine whether an entity is masked.

Return Values

If the entity is not masked, these functions return 0. If the entity is masked, they return 1. In the event of error, they return -1.

Errors

These functions will fail if:

SCF_ERROR_EXISTS

The entity is not masked.

SCF_ERROR_DELETED

The entity or one of its parents has been deleted.

SCF_ERROR_NOT_SET

The entity is not set.

SCF_ERROR_NOT_BOUND

The repository handle is not bound.

SCF_ERROR_CONNECTION_BROKEN

The connection to the repository was lost.

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

Attributes

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

See Also

libscf(3LIB), scf_error(3SCF), scf_handle_create(3SCF), scf_handle_decode_fmri(3SCF), scf_iter_create(3SCF), attributes(5)