JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
man pages section 3: Extended Library Functions, Volume 4     Oracle Solaris 11.1 Information Library
search filter icon
search icon

Document Information

Preface

Extended Library Functions, Volume 4

acl_check(3SEC)

aclcheck(3SEC)

acl_free(3SEC)

aclfrommode(3SEC)

acl_fromtext(3SEC)

aclfromtext(3SEC)

acl_get(3SEC)

acl_set(3SEC)

aclsort(3SEC)

acl_strip(3SEC)

acltomode(3SEC)

acl_totext(3SEC)

acltotext(3SEC)

acl_trivial(3SEC)

bcleartoh(3TSOL)

bcleartoh_r(3TSOL)

bcleartos(3TSOL)

blcompare(3TSOL)

bldominates(3TSOL)

blequal(3TSOL)

blinrange(3TSOL)

blmaximum(3TSOL)

blminimum(3TSOL)

blminmax(3TSOL)

blstrictdom(3TSOL)

bltocolor(3TSOL)

bltocolor_r(3TSOL)

bltos(3TSOL)

bsltoh(3TSOL)

bsltoh_r(3TSOL)

bsltos(3TSOL)

btohex(3TSOL)

cfc_file_start(3TECLA)

cfc_literal_escapes(3TECLA)

cfc_set_check_fn(3TECLA)

cpl_add_completion(3TECLA)

cpl_check_exe(3TECLA)

cpl_complete_word(3TECLA)

cpl_file_completions(3TECLA)

cpl_last_error(3TECLA)

cpl_list_completions(3TECLA)

cpl_recall_matches(3TECLA)

cpl_record_error(3TECLA)

del_CplFileConf(3TECLA)

del_ExpandFile(3TECLA)

del_GetLine(3TECLA)

del_PathCache(3TECLA)

del_PcaPathConf(3TECLA)

del_WordCompletion(3TECLA)

ef_expand_file(3TECLA)

ef_last_error(3TECLA)

ef_list_expansions(3TECLA)

facl_get(3SEC)

facl_set(3SEC)

getpathbylabel(3TSOL)

getplabel(3TSOL)

getuserrange(3TSOL)

getzoneidbylabel(3TSOL)

getzonelabelbyid(3TSOL)

getzonelabelbyname(3TSOL)

getzonerootbyid(3TSOL)

getzonerootbylabel(3TSOL)

getzonerootbyname(3TSOL)

gl_abandon_line(3TECLA)

gl_append_history(3TECLA)

gl_automatic_history(3TECLA)

gl_bind_keyseq(3TECLA)

gl_catch_blocked(3TECLA)

gl_change_terminal(3TECLA)

gl_clear_history(3TECLA)

gl_completion_action(3TECLA)

gl_configure_getline(3TECLA)

gl_customize_completion(3TECLA)

gl_display_text(3TECLA)

gl_echo_mode(3TECLA)

gl_erase_terminal(3TECLA)

gl_error_message(3TECLA)

gl_get_line(3TECLA)

gl_group_history(3TECLA)

gl_handle_signal(3TECLA)

gl_ignore_signal(3TECLA)

gl_inactivity_timeout(3TECLA)

gl_io_mode(3TECLA)

gl_last_signal(3TECLA)

gl_limit_history(3TECLA)

gl_list_signals(3TECLA)

gl_load_history(3TECLA)

gl_lookup_history(3TECLA)

gl_normal_io(3TECLA)

gl_pending_io(3TECLA)

gl_prompt_style(3TECLA)

gl_query_char(3TECLA)

gl_range_of_history(3TECLA)

gl_raw_io(3TECLA)

gl_read_char(3TECLA)

gl_register_action(3TECLA)

gl_replace_prompt(3TECLA)

gl_resize_history(3TECLA)

gl_return_status(3TECLA)

gl_save_history(3TECLA)

gl_set_term_size(3TECLA)

gl_show_history(3TECLA)

gl_size_of_history(3TECLA)

gl_state_of_history(3TECLA)

gl_terminal_size(3TECLA)

gl_toggle_history(3TECLA)

gl_trap_signal(3TECLA)

gl_tty_signals(3TECLA)

gl_watch_fd(3TECLA)

h_alloc(3TSOL)

hextob(3TSOL)

h_free(3TSOL)

htobclear(3TSOL)

htobsl(3TSOL)

labelclipping(3TSOL)

label_to_str(3TSOL)

libtecla_version(3TECLA)

media_findname(3VOLMGT)

media_getattr(3VOLMGT)

media_getid(3VOLMGT)

media_setattr(3VOLMGT)

m_label(3TSOL)

m_label_alloc(3TSOL)

m_label_dup(3TSOL)

m_label_free(3TSOL)

new_CplFileConf(3TECLA)

new_ExpandFile(3TECLA)

new_GetLine(3TECLA)

new_PathCache(3TECLA)

new_PcaPathConf(3TECLA)

new_WordCompletion(3TECLA)

pca_last_error(3TECLA)

pca_lookup_file(3TECLA)

pca_path_completions(3TECLA)

pca_scan_path(3TECLA)

pca_set_check_fn(3TECLA)

ppc_file_start(3TECLA)

ppc_literal_escapes(3TECLA)

sbcleartos(3TSOL)

sbltos(3TSOL)

sbsltos(3TSOL)

scf_count_ranges_destroy(3SCF)

scf_decoration_create(3SCF)

scf_decoration_destroy(3SCF)

scf_decoration_get_bundle(3SCF)

scf_decoration_get_layer(3SCF)

scf_decoration_get_value(3SCF)

scf_decoration_handle(3SCF)

scf_decoration_is_type(3SCF)

scf_decoration_layer_from_string(3SCF)

scf_decoration_layer_to_string(3SCF)

scf_decoration_type(3SCF)

scf_entry_add_value(3SCF)

scf_entry_create(3SCF)

scf_entry_destroy(3SCF)

scf_entry_destroy_children(3SCF)

scf_entry_handle(3SCF)

scf_entry_reset(3SCF)

scf_error(3SCF)

scf_handle_bind(3SCF)

scf_handle_create(3SCF)

scf_handle_decode_fmri(3SCF)

scf_handle_decorate(3SCF)

scf_handle_destroy(3SCF)

scf_handle_get_scope(3SCF)

scf_handle_unbind(3SCF)

scf_instance_add_pg(3SCF)

scf_instance_create(3SCF)

scf_instance_delcust(3SCF)

scf_instance_delete(3SCF)

scf_instance_destroy(3SCF)

scf_instance_get_decoration(3SCF)

scf_instance_get_name(3SCF)

scf_instance_get_parent(3SCF)

scf_instance_get_pg(3SCF)

scf_instance_get_pg_composed(3SCF)

scf_instance_get_snapshot(3SCF)

scf_instance_handle(3SCF)

scf_instance_is_complete(3SCF)

scf_instance_is_masked(3SCF)

scf_instance_to_fmri(3SCF)

scf_int_ranges_destroy(3SCF)

scf_iter_create(3SCF)

scf_iter_decoration_values(3SCF)

scf_iter_destroy(3SCF)

scf_iter_handle(3SCF)

scf_iter_handle_scopes(3SCF)

scf_iter_instance_decorations(3SCF)

scf_iter_instance_pgs(3SCF)

scf_iter_instance_pgs_composed(3SCF)

scf_iter_instance_pgs_typed(3SCF)

scf_iter_instance_pgs_typed_composed(3SCF)

scf_iter_instance_snapshots(3SCF)

scf_iter_next_decoration(3SCF)

scf_iter_next_instance(3SCF)

scf_iter_next_pg(3SCF)

scf_iter_next_property(3SCF)

scf_iter_next_scope(3SCF)

scf_iter_next_service(3SCF)

scf_iter_next_snapshot(3SCF)

scf_iter_next_value(3SCF)

scf_iter_pg_decorations(3SCF)

scf_iter_pg_properties(3SCF)

scf_iter_property_decorations(3SCF)

scf_iter_property_values(3SCF)

scf_iter_reset(3SCF)

scf_iter_scope_services(3SCF)

scf_iter_service_decorations(3SCF)

scf_iter_service_instances(3SCF)

scf_iter_service_pgs(3SCF)

scf_iter_service_pgs_typed(3SCF)

scf_iter_snaplevel_pgs(3SCF)

scf_iter_snaplevel_pgs_typed(3SCF)

scf_limit(3SCF)

scf_myname(3SCF)

scf_pg_create(3SCF)

scf_pg_delcust(3SCF)

scf_pg_delete(3SCF)

scf_pg_destroy(3SCF)

scf_pg_get_decoration(3SCF)

scf_pg_get_flags(3SCF)

scf_pg_get_name(3SCF)

scf_pg_get_parent_instance(3SCF)

scf_pg_get_parent_service(3SCF)

scf_pg_get_parent_snaplevel(3SCF)

scf_pg_get_property(3SCF)

scf_pg_get_type(3SCF)

scf_pg_get_underlying_pg(3SCF)

scf_pg_handle(3SCF)

scf_pg_is_masked(3SCF)

scf_pg_to_fmri(3SCF)

scf_pg_update(3SCF)

scf_property_create(3SCF)

scf_property_delcust(3SCF)

scf_property_destroy(3SCF)

scf_property_get_decoration(3SCF)

scf_property_get_name(3SCF)

scf_property_get_value(3SCF)

scf_property_get_value_at_layer(3SCF)

scf_property_handle(3SCF)

scf_property_is_masked(3SCF)

scf_property_is_type(3SCF)

scf_property_to_fmri(3SCF)

scf_property_type(3SCF)

scf_scope_add_service(3SCF)

scf_scope_create(3SCF)

scf_scope_destroy(3SCF)

scf_scope_get_name(3SCF)

scf_scope_get_service(3SCF)

scf_scope_handle(3SCF)

scf_scope_to_fmri(3SCF)

scf_service_add_instance(3SCF)

scf_service_add_pg(3SCF)

scf_service_create(3SCF)

scf_service_delcust(3SCF)

scf_service_delete(3SCF)

scf_service_destroy(3SCF)

scf_service_get_decoration(3SCF)

scf_service_get_instance(3SCF)

scf_service_get_name(3SCF)

scf_service_get_parent(3SCF)

scf_service_get_pg(3SCF)

scf_service_handle(3SCF)

scf_service_is_masked(3SCF)

scf_service_to_fmri(3SCF)

scf_simple_app_props_free(3SCF)

scf_simple_app_props_get(3SCF)

scf_simple_app_props_next(3SCF)

scf_simple_app_props_search(3SCF)

scf_simple_prop_free(3SCF)

scf_simple_prop_get(3SCF)

scf_simple_prop_name(3SCF)

scf_simple_prop_next_astring(3SCF)

scf_simple_prop_next_boolean(3SCF)

scf_simple_prop_next_count(3SCF)

scf_simple_prop_next_integer(3SCF)

scf_simple_prop_next_opaque(3SCF)

scf_simple_prop_next_reset(3SCF)

scf_simple_prop_next_time(3SCF)

scf_simple_prop_next_ustring(3SCF)

scf_simple_prop_numvalues(3SCF)

scf_simple_prop_pgname(3SCF)

scf_simple_prop_type(3SCF)

scf_simple_walk_instances(3SCF)

scf_snaplevel_create(3SCF)

scf_snaplevel_destroy(3SCF)

scf_snaplevel_get_instance_name(3SCF)

scf_snaplevel_get_next_snaplevel(3SCF)

scf_snaplevel_get_parent(3SCF)

scf_snaplevel_get_pg(3SCF)

scf_snaplevel_get_scope_name(3SCF)

scf_snaplevel_get_service_name(3SCF)

scf_snaplevel_handle(3SCF)

scf_snapshot_create(3SCF)

scf_snapshot_destroy(3SCF)

scf_snapshot_get_base_snaplevel(3SCF)

scf_snapshot_get_name(3SCF)

scf_snapshot_get_parent(3SCF)

scf_snapshot_handle(3SCF)

scf_snapshot_update(3SCF)

scf_strerror(3SCF)

scf_string_to_type(3SCF)

scf_tmpl_error_pg(3SCF)

scf_tmpl_error_pg_tmpl(3SCF)

scf_tmpl_error_prop(3SCF)

scf_tmpl_error_prop_tmpl(3SCF)

scf_tmpl_errors_destroy(3SCF)

scf_tmpl_error_source_fmri(3SCF)

scf_tmpl_error_type(3SCF)

scf_tmpl_error_value(3SCF)

scf_tmpl_get_by_pg(3SCF)

scf_tmpl_get_by_pg_name(3SCF)

scf_tmpl_get_by_prop(3SCF)

scf_tmpl_iter_pgs(3SCF)

scf_tmpl_iter_props(3SCF)

scf_tmpl_next_error(3SCF)

scf_tmpl_pg_common_name(3SCF)

scf_tmpl_pg_create(3SCF)

scf_tmpl_pg_description(3SCF)

scf_tmpl_pg_destroy(3SCF)

scf_tmpl_pg_name(3SCF)

scf_tmpl_pg_required(3SCF)

scf_tmpl_pg_reset(3SCF)

scf_tmpl_pg_target(3SCF)

scf_tmpl_pg_type(3SCF)

scf_tmpl_prop_cardinality(3SCF)

scf_tmpl_prop_common_name(3SCF)

scf_tmpl_prop_create(3SCF)

scf_tmpl_prop_description(3SCF)

scf_tmpl_prop_destroy(3SCF)

scf_tmpl_prop_internal_seps(3SCF)

scf_tmpl_prop_name(3SCF)

scf_tmpl_prop_required(3SCF)

scf_tmpl_prop_reset(3SCF)

scf_tmpl_prop_type(3SCF)

scf_tmpl_prop_units(3SCF)

scf_tmpl_prop_visibility(3SCF)

scf_tmpl_reset_errors(3SCF)

scf_tmpl_strerror(3SCF)

scf_tmpl_validate_fmri(3SCF)

scf_tmpl_value_common_name(3SCF)

scf_tmpl_value_count_range_choices(3SCF)

scf_tmpl_value_count_range_constraints(3SCF)

scf_tmpl_value_description(3SCF)

scf_tmpl_value_in_constraint(3SCF)

scf_tmpl_value_int_range_choices(3SCF)

scf_tmpl_value_int_range_constraints(3SCF)

scf_tmpl_value_name_choices(3SCF)

scf_tmpl_value_name_constraints(3SCF)

scf_tmpl_visibility_to_string(3SCF)

scf_transaction_commit(3SCF)

scf_transaction_create(3SCF)

scf_transaction_destroy(3SCF)

scf_transaction_destroy_children(3SCF)

scf_transaction_handle(3SCF)

scf_transaction_property_change(3SCF)

scf_transaction_property_change_type(3SCF)

scf_transaction_property_delete(3SCF)

scf_transaction_property_new(3SCF)

scf_transaction_reset(3SCF)

scf_transaction_reset_all(3SCF)

scf_transaction_start(3SCF)

scf_type_base_type(3SCF)

scf_type_to_string(3SCF)

scf_value_base_type(3SCF)

scf_value_create(3SCF)

scf_value_destroy(3SCF)

scf_value_get_as_string(3SCF)

scf_value_get_as_string_typed(3SCF)

scf_value_get_astring(3SCF)

scf_value_get_boolean(3SCF)

scf_value_get_count(3SCF)

scf_value_get_integer(3SCF)

scf_value_get_opaque(3SCF)

scf_value_get_time(3SCF)

scf_value_get_ustring(3SCF)

scf_value_handle(3SCF)

scf_value_is_type(3SCF)

scf_value_reset(3SCF)

scf_values_destroy(3SCF)

scf_value_set_astring(3SCF)

scf_value_set_boolean(3SCF)

scf_value_set_count(3SCF)

scf_value_set_from_string(3SCF)

scf_value_set_integer(3SCF)

scf_value_set_opaque(3SCF)

scf_value_set_time(3SCF)

scf_value_set_ustring(3SCF)

scf_value_type(3SCF)

setflabel(3TSOL)

smf_degrade_instance(3SCF)

smf_disable_instance(3SCF)

smf_enable_instance(3SCF)

smf_get_state(3SCF)

smf_maintain_instance(3SCF)

smf_method_exit(3SCF)

smf_notify_del_params(3SCF)

smf_notify_get_params(3SCF)

smf_notify_set_params(3SCF)

smf_refresh_instance(3SCF)

smf_restart_instance(3SCF)

smf_restore_instance(3SCF)

smf_state_from_string(3SCF)

smf_state_to_string(3SCF)

srpt_GetDefaultState(3SRPT)

srpt_GetTargetState(3SRPT)

srpt_ResetTarget(3SRPT)

srpt_SetDefaultState(3SRPT)

srpt_SetTargetState(3SRPT)

SSAAgentIsAlive(3SNMP)

SSAGetTrapPort(3SNMP)

SSAOidCmp(3SNMP)

SSAOidCpy(3SNMP)

SSAOidDup(3SNMP)

SSAOidFree(3SNMP)

SSAOidInit(3SNMP)

SSAOidNew(3SNMP)

SSAOidString(3SNMP)

SSAOidStrToOid(3SNMP)

SSAOidZero(3SNMP)

SSARegSubagent(3SNMP)

SSARegSubtable(3SNMP)

SSARegSubtree(3SNMP)

SSASendTrap(3SNMP)

SSAStringCpy(3SNMP)

SSAStringInit(3SNMP)

SSAStringToChar(3SNMP)

SSAStringZero(3SNMP)

SSASubagentOpen(3SNMP)

stmfAddToHostGroup(3STMF)

stmfAddToHostGroupList(3STMF)

stmfAddToTargetGroup(3STMF)

stmfAddViewEntry(3STMF)

stmfAddViewEntryList(3STMF)

stmfCheckHostGroupInUse(3STMF)

stmfCheckTargetGroupInUse(3STMF)

stmfClearProviderData(3STMF)

stmfCreateHostGroup(3STMF)

stmfCreateLu(3STMF)

stmfCreateLuResource(3STMF)

stmfCreateTargetGroup(3STMF)

stmfDeleteHostGroup(3STMF)

stmfDeleteLu(3STMF)

stmfDeleteTargetGroup(3STMF)

stmfDestroyProxyDoor(3STMF)

stmfDevidFromIscsiName(3STMF)

stmfDevidFromWwn(3STMF)

stmfFreeLuResource(3STMF)

stmfFreeMemory(3STMF)

stmfFreeViewResourceList(3STMF)

stmfGetAluaState(3STMF)

stmfGetHostGroupList(3STMF)

stmfGetHostGroupMembers(3STMF)

stmfGetLogicalUnitList(3STMF)

stmfGetLogicalUnitProperties(3STMF)

stmfGetLuProp(3STMF)

stmfGetLuResource(3STMF)

stmfGetPersistMethod(3STMF)

stmfGetProviderData(3STMF)

stmfGetProviderDataProt(3STMF)

stmfGetState(3STMF)

stmfGetStmfProp(3STMF)

stmfGetTargetGroupList(3STMF)

stmfGetTargetGroupMembers(3STMF)

stmfGetTargetList(3STMF)

stmfGetTargetProperties(3STMF)

stmfGetViewEntryList(3STMF)

stmfGetViewLuNumberList(3STMF)

stmfGetViewProp(3STMF)

stmfGetViewResourceList(3STMF)

stmfImportLu(3STMF)

stmfInitProxyDoor(3STMF)

stmfLuStandby(3STMF)

stmfModifyLu(3STMF)

stmfModifyLuByFname(3STMF)

stmfOfflineLogicalUnit(3STMF)

stmfOfflineTarget(3STMF)

stmfOnlineLogicalUnit(3STMF)

stmfOnlineTarget(3STMF)

stmfPostProxyMsg(3STMF)

stmfRemoveFromHostGroup(3STMF)

stmfRemoveFromTargetGroup(3STMF)

stmfRemoveViewEntry(3STMF)

stmfSetAluaState(3STMF)

stmfSetLuProp(3STMF)

stmfSetPersistMethod(3STMF)

stmfSetProviderData(3STMF)

stmfSetProviderDataProt(3STMF)

stmfSetStmfProp(3STMF)

stmfValidateView(3STMF)

stobclear(3TSOL)

stobl(3TSOL)

stobsl(3TSOL)

str_to_label(3TSOL)

sysevent_bind_handle(3SYSEVENT)

sysevent_free(3SYSEVENT)

sysevent_get_attr_list(3SYSEVENT)

sysevent_get_class_name(3SYSEVENT)

sysevent_get_pid(3SYSEVENT)

sysevent_get_pub_name(3SYSEVENT)

sysevent_get_seq(3SYSEVENT)

sysevent_get_size(3SYSEVENT)

sysevent_get_subclass_name(3SYSEVENT)

sysevent_get_time(3SYSEVENT)

sysevent_get_vendor_name(3SYSEVENT)

sysevent_post_event(3SYSEVENT)

sysevent_subscribe_event(3SYSEVENT)

sysevent_unbind_handle(3SYSEVENT)

sysevent_unsubscribe_event(3SYSEVENT)

tsol_getrhtype(3TSOL)

uuid_clear(3UUID)

uuid_compare(3UUID)

uuid_copy(3UUID)

uuid_generate(3UUID)

uuid_generate_random(3UUID)

uuid_generate_time(3UUID)

uuid_is_null(3UUID)

uuid_parse(3UUID)

uuid_time(3UUID)

uuid_unparse(3UUID)

volmgt_acquire(3VOLMGT)

volmgt_check(3VOLMGT)

volmgt_feature_enabled(3VOLMGT)

volmgt_inuse(3VOLMGT)

volmgt_ownspath(3VOLMGT)

volmgt_release(3VOLMGT)

volmgt_root(3VOLMGT)

volmgt_running(3VOLMGT)

volmgt_symdev(3VOLMGT)

volmgt_symname(3VOLMGT)

Xbcleartos(3TSOL)

Xbsltos(3TSOL)

XTSOLgetClientAttributes(3XTSOL)

XTSOLgetPropAttributes(3XTSOL)

XTSOLgetPropLabel(3XTSOL)

XTSOLgetPropUID(3XTSOL)

XTSOLgetResAttributes(3XTSOL)

XTSOLgetResLabel(3XTSOL)

XTSOLgetResUID(3XTSOL)

XTSOLgetSSHeight(3XTSOL)

XTSOLgetWorkstationOwner(3XTSOL)

XTSOLIsWindowTrusted(3XTSOL)

XTSOLMakeTPWindow(3XTSOL)

XTSOLsetPolyInstInfo(3XTSOL)

XTSOLsetPropLabel(3XTSOL)

XTSOLsetPropUID(3XTSOL)

XTSOLsetResLabel(3XTSOL)

XTSOLsetResUID(3XTSOL)

XTSOLsetSessionHI(3XTSOL)

XTSOLsetSessionLO(3XTSOL)

XTSOLsetSSHeight(3XTSOL)

XTSOLsetWorkstationOwner(3XTSOL)

zs_close(3ZONESTAT)

zs_open(3ZONESTAT)

zs_property(3ZONESTAT)

zs_property_double(3ZONESTAT)

zs_property_int(3ZONESTAT)

zs_property_int64(3ZONESTAT)

zs_property_string(3ZONESTAT)

zs_property_type(3ZONESTAT)

zs_property_uint(3ZONESTAT)

zs_property_uint64(3ZONESTAT)

zs_pset(3ZONESTAT)

zs_pset_list(3ZONESTAT)

zs_pset_property(3ZONESTAT)

zs_pset_total_cpus(3ZONESTAT)

zs_pset_total_time(3ZONESTAT)

zs_pset_used_cpus(3ZONESTAT)

zs_pset_used_pct(3ZONESTAT)

zs_pset_used_time(3ZONESTAT)

zs_pset_walk(3ZONESTAT)

zs_pset_zone(3ZONESTAT)

zs_pset_zone_get_pset(3ZONESTAT)

zs_pset_zone_get_zone(3ZONESTAT)

zs_pset_zone_list(3ZONESTAT)

zs_pset_zone_property(3ZONESTAT)

zs_pset_zone_used_cpus(3ZONESTAT)

zs_pset_zone_used_pct(3ZONESTAT)

zs_pset_zone_used_time(3ZONESTAT)

zs_pset_zone_walk(3ZONESTAT)

zs_resource(3ZONESTAT)

zs_resource_property(3ZONESTAT)

zs_resource_total_time(3ZONESTAT)

zs_resource_total_uint64(3ZONESTAT)

zs_resource_type(3ZONESTAT)

zs_resource_used_pct(3ZONESTAT)

zs_resource_used_time(3ZONESTAT)

zs_resource_used_uint64(3ZONESTAT)

zs_resource_used_zone_pct(3ZONESTAT)

zs_resource_used_zone_time(3ZONESTAT)

zs_resource_used_zone_uint64(3ZONESTAT)

zs_usage(3ZONESTAT)

zs_usage_diff(3ZONESTAT)

zs_usage_free(3ZONESTAT)

zs_usage_read(3ZONESTAT)

zs_zone(3ZONESTAT)

zs_zone_limit_time(3ZONESTAT)

zs_zone_limit_type(3ZONESTAT)

zs_zone_limit_uint64(3ZONESTAT)

zs_zone_limit_used_pct(3ZONESTAT)

zs_zone_limit_used_time(3ZONESTAT)

zs_zone_limit_used_uint64(3ZONESTAT)

zs_zone_list(3ZONESTAT)

zs_zone_property(3ZONESTAT)

zs_zone_walk(3ZONESTAT)

scf_value_create

, scf_value_handle

, scf_value_reset

, scf_value_destroy

, scf_value_type

, scf_value_base_type

, scf_value_is_type

, scf_type_base_type

, scf_value_get_boolean

, scf_value_get_count

, scf_value_get_integer

, scf_value_get_time

, scf_value_get_astring

, scf_value_get_ustring

, scf_value_get_opaque

, scf_value_get_as_string

, scf_value_get_as_string_typed

, scf_value_set_boolean

, scf_value_set_count

, scf_value_set_integer

, scf_value_set_time

, scf_value_set_from_string

, scf_value_set_astring

, scf_value_set_ustring

, scf_value_set_opaque

- manipulate values in the Service Configuration Facility

Synopsis

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

scf_value_t *scf_value_create(scf_handle_t *h);
scf_handle_t *scf_value_handle(scf_value_t *v);
void scf_value_reset(scf_value_t *v);
void scf_value_destroy(scf_value_t *v);
int scf_value_type(scf_value_t *v);
int scf_value_base_type(scf_value_t *v);
int scf_value_is_type(scf_value_t *v, scf_type_t type);
int scf_type_base_type(scf_type_t type, scf_type_t *out);
int scf_value_get_boolean(scf_value_t *v, uint8_t *out);
int scf_value_get_count(scf_value_t *v, uint64_t *out);
int scf_value_get_integer(scf_value_t *v, int64_t *out);
int scf_value_get_time(scf_value_t *v, int64_t *seconds,
     int32_t *ns);
ssize_t scf_value_get_astring(scf_value_t *v, char *buf,
     size_t size);
ssize_t scf_value_get_ustring(scf_value_t *v, char *buf,
     size_t size);
ssize_t scf_value_get_opaque(scf_value_t *v, char *out,
     size_t len);
ssize_t scf_value_get_as_string(scf_value_t *v, char *buf,
     size_t size);
ssize_t scf_value_get_as_string_typed(scf_value_t *v,
     scf_type_t type, char *buf, size_t size);
void scf_value_set_boolean(scf_value_t *v, uint8_t in);
void scf_value_set_count(scf_value_t *v, uint64_t in);
void scf_value_set_integer(scf_value_t *v, int64_t in);
int scf_value_set_time(scf_value_t *v, int64_t seconds,
     int32_t ns);
int scf_value_set_from_string(scf_value_t *v, scf_type_t type,
     char *in);
int scf_value_set_astring(scf_value_t *v, const char *in);
int scf_value_set_ustring(scf_value_t *v, const char *in);
int scf_value_set_opaque(scf_value_t *v, void *in, size_t sz);

Description

The scf_value_create() function creates a new, reset scf_value_t that holds a single typed value. The value can be used only with the handle specified by h and objects associated with h.

The scf_value_reset() function resets the value to the uninitialized state. The scf_value_destroy() function deallocates the object.

The scf_value_type() function retrieves the type of the contents of v. The scf_value_is_type() function determines if a value is of a particular type or any of its subtypes. The scf_type_base_type() function returns the base type of type. The scf_value_base_type() function returns the true base type of the value (the highest type reachable from the value's type).

Type Identifier
Base Type
Type Description
SCF_TYPE_INVALID
reserved invalid type
SCF_TYPE_BOOLEAN
single bit
SCF_TYPE_COUNT
unsigned 64-bit quantity
SCF_TYPE_INTEGER
signed 64-bit quantity
SCF_TYPE_TIME
signed 64-bit seconds, signed 32-bit nanoseconds in the range 0 <= ns < 1,000,000,000
SCF_TYPE_ASTRING
8-bit NUL-terminated string
SCF_TYPE_OPAQUE
opaque 8-bit data
SCF_TYPE_USTRING
ASTRING
8-bit UTF-8 string
SCF_TYPE_URI
USTRING
a URI string
SCF_TYPE_FMRI
URI
a Fault Management Resource Identifier
SCF_TYPE_HOST
USTRING
either a hostname, IPv4 address, or IPv6 address
SCF_TYPE_HOSTNAME
HOST
a fully-qualified domain name
SCF_TYPE_NET_ADDR
HOST
a valid SCF_TYPE_NET_ADDR_V4 or SCF_TYPE_NET_ADDR_V6 address
SCF_TYPE_NET_ADDR_V4
NET_ADDR
a dotted-quad IPv4 address with optional network portion
SCF_TYPE_NET_ADDR_V6
NET_ADDR
legal IPv6 address with optional network portion

The scf_value_get_boolean(), scf_value_get_count(), scf_value_get_integer(), scf_value_get_time(), scf_value_get_astring(), scf_value_get_ustring(), and scf_value_get_opaque() functions read a particular type of value from v.

The scf_value_get_as_string() and scf_value_get_as_string_typed() functions convert the value to a string form. For scf_value_get_as_string_typed(), the value must be a reachable subtype of type.

The scf_value_set_boolean(), scf_value_set_count(), scf_value_set_integer(), scf_value_set_time(), scf_value_set_astring(), scf_value_set_ustring(), and scf_value_set_opaque() functions set v to a particular value of a particular type.

The scf_value_set_from_string() function is the inverse of scf_value_get_as_string(). It sets v to the value encoded in buf of type type.

The scf_value_set_*() functions will succeed on scf_value_t objects that have already been set.

Return Values

Upon successful completion, scf_value_create() returns a new, reset scf_value_t. Otherwise, it returns NULL.

Upon successful completion, scf_value_handle() returns the handle associated with v. Otherwise, it returns NULL.

The scf_value_base_type() function returns the base type of the value, or SCF_TYPE_INVALID on failure.

Upon successful completion, scf_value_type() returns the type of the value. Otherwise, it returns SCF_TYPE_INVALID.

Upon successful completion, scf_value_is_type(), scf_value_get_boolean(), scf_value_get_count(), scf_value_get_integer(), scf_value_get_time(), scf_value_set_time(), scf_value_set_from_string(), scf_value_set_astring(), scf_value_set_ustring(), and scf_value_set_opaque() return 0. Otherwise, they return -1.

Upon successful completion, scf_value_get_astring(), scf_value_get_ustring(), scf_value_get_as_string(), and scf_value_get_as_string_typed() return the length of the source string, not including the terminating null byte. Otherwise, they return -1.

Upon successful completion, scf_value_get_opaque() returns the number of bytes written. Otherwise, it returns -1.

Errors

The scf_value_create() function will fail if:

SCF_ERROR_HANDLE_DESTROYED

The handle associated with h has been destroyed.

SCF_ERROR_INVALID_ARGUMENT

The handle is NULL.

SCF_ERROR_NO_MEMORY

There is not enough memory to allocate an scf_value_t.

The scf_value_handle() function will fail if:

SCF_ERROR_HANDLE_DESTROYED

The handle associated with v has been destroyed.

The scf_value_set_time() function will fail if:

SCF_ERROR_INVALID_ARGUMENT

The nanoseconds field is not in the range 0 <= ns < 1,000,000,000.

The scf_type_base_type() function will fail if:

SCF_ERROR_INVALID_ARGUMENT

The type argument is not a valid type.

The scf_value_set_astring(), scf_value_set_ustring(), scf_value_set_opaque(), and scf_value_set_from_string() functions will fail if:

SCF_ERROR_INVALID_ARGUMENT

The in argument is not a valid value for the specified type or is longer than the maximum supported value length.

The scf_type_base_type(), scf_value_is_type(), and scf_value_get_as_string_typed() functions will fail if:

SCF_ERROR_INVALID_ARGUMENT

The type argument is not a valid type.

The scf_value_type(), scf_value_base_type(), scf_value_get_boolean(), scf_value_get_count(), scf_value_get_integer(), scf_value_get_time(), scf_value_get_astring(), scf_value_get_ustring(), scf_value_get_as_string(), andscf_value_get_as_string_typed() functions will fail if:

SCF_ERROR_NOT_SET

The v argument has not been set to a value.

The scf_value_get_boolean(), scf_value_get_count(), scf_value_get_integer(), scf_value_get_time(), scf_value_get_astring(), scf_value_get_ustring(), and scf_value_get_as_string_typed() functions will fail if:

SCF_ERROR_TYPE_MISMATCH

The requested type is not the same as the value's type and is not in the base-type chain.

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

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See Also

libscf(3LIB), scf_entry_add_value(3SCF), scf_error(3SCF), attributes(5)