scf_simple_walk_instances man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]

SCF_SIMPLE_WALK_INSTANCES(3SCF)		       SCF_SIMPLE_WALK_INSTANCES(3SCF)

NAME
       scf_simple_walk_instances - observational interface for Service Config‐
       uration Facility

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

       int scf_simple_walk_instances(uint_t flags, void *private,
	    int (*inst_callback)(scf_handle_t *, scf_instance_t *, void *));

DESCRIPTION
       The scf_simple_walk_instances() function iterates  over	every  service
       instance in a specified state and calls a callback function provided by
       the user on each specified instance.

       The function takes a flags argument to indicate which  instance	states
       are  involved  in  the  iteration, an opaque buffer to be passed to the
       callback function, and a callback function with three arguments, a han‐
       dle,  an	 instance pointer, and an opaque buffer. If the callback func‐
       tion returns a value other than success, iteration is ended,  an	 error
       is set, and the function returns -1.

       The  handle passed to the callback function is provided to the callback
       function by the library. This handle is used by the  callback  function
       for all low-level allocation involved in the function.

       The  simplified	library provides defined constants for the flags argu‐
       ment.  The user can use a bitwise OR to apply more than one  flag.  The
       SCF_STATE_ALL  flag  is	a bitwise OR of all the other states.The flags
       are:

	   o	  SCF_STATE_UNINIT

	   o	  SCF_STATE_MAINT

	   o	  SCF_STATE_OFFLINE

	   o	  SCF_STATE_DISABLED

	   o	  SCF_STATE_ONLINE

	   o	  SCF_STATE_DEGRADED

	   o	  SCF_STATE_ALL

RETURN VALUES
       Upon  successful	 completion,  scf_simple_walk_instances()  returns  0.
       Otherwise, it returns -1.

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

       ┌────────────────────┬─────────────────┐
       │  ATTRIBUTE TYPE    │ ATTRIBUTE VALUE │
       ├────────────────────┼─────────────────┤
       │Interface Stability │ Evolving	      │
       ├────────────────────┼─────────────────┤
       │MT-Level	    │ MT-Safe	      │
       └────────────────────┴─────────────────┘

SEE ALSO
       libscf(3LIB), attributes(5)

				 Aug 17, 2004  SCF_SIMPLE_WALK_INSTANCES(3SCF)
[top]

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net