Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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	speci-
       fied are	also passed to the filter function.

       As the ToolTalk service finds each object, it calls  the	 filter	 func-
       tion,  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
       interpret 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	filter
       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 values:

       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 ser-
		 vice 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_fil-
		 ter_function.

SEE ALSO
       Tt/tt_c.h - Tttt_c(5).

					   tt_file_objects_query(library call)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=tt_file_objects_query&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help