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

FreeBSD Manual Pages

  
 
  

home | help
WordListOne(3)		   Library Functions Manual		WordListOne(3)

NAME
       WordListOne -

       manage and use an inverted index	file.

SYNOPSIS
       #include	<mifluz.h>

       WordContext context;

       WordList* words = context->List();
       WordList* words = WordListOne(context)

DESCRIPTION
       WordList	 is the	mifluz equivalent of a database	handler. Each WordList
       object is bound to an inverted index file and implements	the operations
       to create it, fill it with word occurrences and	search	for  an	 entry
       matching	a given	criterion.

       The  general behavious of WordListOne is	described in the WordList man-
       ual page. It is prefered	to create a WordListOne	 instance  by  setting
       the  wordlist_multi  configuration  parameter  to false and calling the
       WordContext::List method.

       Only the	methods	that differ from WordList are listed  here.   All  the
       methods of WordList are implemented by WordListOne and you should refer
       to the manual page for more information.

       The  Cursor methods all return a	WordCursorOne instance cast to a Word-
       Cursor object.

METHODS
       WordListOne(WordContext*	ncontext)
	      Constructor. Build inverted index	handling object	using run time
	      configuration parameters listed in the CONFIGURATION section  of
	      the WordList manual page.

       int DeleteCursor(WordDBCursor& cursor)
	      Delete the inverted index	entry currently	pointed	to by the cur-
	      sor.   Returns  0	 on  success, Berkeley DB error	code on	error.
	      This is mainly useful when implementing a	callback function  for
	      a	WordCursor.

AUTHORS
       Loic Dachary loic@gnu.org

       The Ht://Dig group http://dev.htdig.org/

SEE ALSO
       htdb_dump(1), htdb_stat(1), htdb_load(1), mifluzdump(1),	mifluzload(1),
       mifluzsearch(1),	  mifluzdict(1),  WordContext(3),  WordList(3),	 Word-
       Dict(3),	WordKey(3), WordKeyInfo(3), WordType(3),  WordDBInfo(3),  Wor-
       dRecordInfo(3),	WordRecord(3),	WordReference(3), WordCursor(3), Word-
       CursorOne(3), WordMonitor(3), Configuration(3), mifluz(3)

				     local			WordListOne(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=WordListOne&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help