---
name: "WordListOne"
section: "3"
platform: "linux"
package: "libmifluz0-dev"
version: "0.24.0-9"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/WordListOne"
---

# WordListOne(3)

manage and use an inverted index file.

## 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 manual 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 WordCursor 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 **cursor.** 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_dump/1.md), [htdb\_stat(1)](/htdb_stat/1.md), [htdb\_load(1)](/htdb_load/1.md), [mifluzdump(1)](/mifluzdump/1.md), [mifluzload(1)](/mifluzload/1.md), [mifluzsearch(1)](/mifluzsearch/1.md), [mifluzdict(1)](/mifluzdict/1.md), [WordContext(3)](/WordContext/3.md), [WordList(3)](/WordList/3.md), [WordDict(3)](/WordDict/3.md), [WordKey(3)](/WordKey/3.md), [WordKeyInfo(3)](/WordKeyInfo/3.md), [WordType(3)](/WordType/3.md), [WordDBInfo(3)](/WordDBInfo/3.md), [WordRecordInfo(3)](/WordRecordInfo/3.md), [WordRecord(3)](/WordRecord/3.md), [WordReference(3)](/WordReference/3.md), [WordCursor(3)](/WordCursor/3.md), [WordCursorOne(3)](/WordCursorOne/3.md), [WordMonitor(3)](/WordMonitor/3.md), [Configuration(3)](/Configuration/3.md), [mifluz(3)](/mifluz/3.md)