<!DOCTYPE File PUBLIC "-//Liam Quin//DTD C API Documentation v1.1//EN" "doc.dtd"><File>
<Entry dir="liblqtext">
<Function File="../../src/liblqtext/common.c">
<Name>LQT_ReadStopList</Name>
<Class>Language/Stop List
<Purpose>
Reads the named file, and adds any words found in it
to the in-memory stop list, to be ignored by LQT_ReadWord.
<Returns>
<LIST>
<LI>the number of words added on success;
<LI>-1 if the file couldn't be opened.
</LIST>
<Errors>
Warns if the file can't be opened.
<SeeAlso>
LQT_WordIsInStopList
<Bugs>
There is no way to clear the stop list; you can only add to it.
The current implementation is inefficient if there are more than
ten or so words.
<Notes>
A future release may support a `go list' of phrases every word of
which is to be indexed.
</Function>
<Decl>
API int
LQT_ReadStopList(db, CommonFile)
    t_LQTEXT_Database *db;
    CONST char *CommonFile;
</Decl>
</Entry>
