tt_file_objects_query(3) [hpux man page]

tt_file_objects_query(library call)									       tt_file_objects_query(library call)

NAME

       tt_file_objects_query -- find all objects in the named file

SYNOPSIS

       #include <Tt/tt_c.h>
       Tt_status tt_file_objects_query(
       const char *filepath,
       Tt_filter_function filter,
       void *context,
       void *accumulator);

DESCRIPTION

       The  tt_file_objects_query  function instructs the ToolTalk service to find all objects in the named file and pass the objids to the filter
       function.  The context pointer and accumulator pointer initially specified are also passed to the filter function.

       As the ToolTalk service finds each object, it calls the filter function, passing the objid of the object and the  two  application-supplied
       pointers.   The filter function performs its computation and returns a Tt_filter_action value that tells the query function whether to con-
       tinue or to stop.  Tt_filter_action values are:

       TT_FILTER_CONTINUE
		 The query function should continue.

       TT_FILTER_STOP
		 The query function should stop.

       The filepath argument is the name of the file to be searched for objects.  The filter argument is the filter function to which  the  objids
       are  to be passed.  The context argument is a pointer to any information the filter needs to execute.  The ToolTalk service does not inter-
       pret this argument, but passes it directly to the filter function.  The accumulator argument is a pointer to where the filter is  to  store
       the  results of the query and filter operations.  The ToolTalk service does not interpret this argument, but passes it directly to the fil-
       ter function.

RETURN VALUE

       Upon successful completion, the tt_file_objects_query function returns the status of the operation as one of the following  Tt_status  val-
       ues:

       TT_OK	 The operation completed successfully.

       TT_ERR_DBAVAIL
		 The ToolTalk service could not access the ToolTalk database needed for this operation.

       TT_ERR_DBEXIST
		 The ToolTalk service could not access the specified ToolTalk database in the expected place.

       TT_ERR_NOMP
		 The ttsession(1) process is not running and the ToolTalk service cannot restart it.

       TT_ERR_PATH
		 The specified pathname included an unsearchable directory.

       TT_WRN_STOPPED
		 The query operation being performed was halted by Tt_filter_function.

SEE ALSO

       Tt/tt_c.h - Tttt_c(5).

													       tt_file_objects_query(library call)

Check Out this Related Man Page

tt_session_bprop(library call)											    tt_session_bprop(library call)

NAME

       tt_session_bprop -- retrieve the ith value of the named property of a session

SYNOPSIS

       #include <Tt/tt_c.h>
       Tt_status tt_session_bprop(
       const char *sessid,
       const char *propname,
       int i,
       unsigned char **value,
       int *length);

DESCRIPTION

       The tt_session_bprop function retrieves the ith value of the named property of the specified session.

       If there are i values or fewer, both the returned value and the returned length are set to zero.

       The sessid argument is the session joined.  The application can use the sessid value returned when tt_default_session is called.  The prop-
       name argument is the name of the property from which values are to be obtained.	The i argument is the number of the item in  the  property
       list  from  which  the  value  is  to  be obtained.  The list numbering begins with zero.  The value argument is the address of a character
       pointer to which the ToolTalk service is to point a string that contains the contents of the property.  The len argument is the address	of
       an integer to which the ToolTalk service is to set the length of the value in bytes.

RETURN VALUE

       Upon successful completion, the tt_session_bprop function returns the status of the operation as one of the following Tt_status values:

       TT_OK	 The operation completed successfully.

       TT_ERR_NOMEM
		 There is insufficient memory available to perform the function.

       TT_ERR_NOMP
		 The ttsession(1) process is not running and the ToolTalk service cannot restart it.

       TT_ERR_NUM
		 The integer value passed was invalid (out of range).

       TT_ERR_PROPNAME
		 The specified property name is syntactically invalid.

       TT_ERR_SESSION
		 The specified ToolTalk session is out of date or invalid.

SEE ALSO

       Tt/tt_c.h - Tttt_c(5).

														    tt_session_bprop(library call)

Linux and UNIX Man Pages

tt_file_objects_query(3) [hpux man page]

Check Out this Related Man Page