opensolaris man page for scf_simple_walk_instances

scf_simple_walk_instances(3SCF) 		 Service Configuration Facility Library Functions		   scf_simple_walk_instances(3SCF)

NAME
       scf_simple_walk_instances - observational interface for Service Configuration 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 handle, 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  func-
       tion for all low-level allocation involved in the function.

       The  simplified	library  provides defined constants for the flags argument. 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)

SunOS 5.11							    17 Aug 2004 				   scf_simple_walk_instances(3SCF)