<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--Converted with LaTeX2HTML 2002-2-1 (1.71)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Database loading</TITLE>
<META NAME="description" CONTENT="Database loading">
<META NAME="keywords" CONTENT="clamdoc">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="clamdoc.css">
<LINK REL="next" HREF="node42.html">
<LINK REL="previous" HREF="node40.html">
<LINK REL="up" HREF="node39.html">
<LINK REL="next" HREF="node42.html">
</HEAD>
<BODY >
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html737"
HREF="node42.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html733"
HREF="node39.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html727"
HREF="node40.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html735"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html738"
HREF="node42.html">Error handling</A>
<B> Up:</B> <A NAME="tex2html734"
HREF="node39.html">API</A>
<B> Previous:</B> <A NAME="tex2html728"
HREF="node40.html">Header file</A>
<B> <A NAME="tex2html736"
HREF="node1.html">Contents</A></B>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H3><A NAME="SECTION00073200000000000000">
Database loading</A>
</H3>
The following set of functions provides an interface for loading
the virus database:
<PRE>
const char *cl_retdbdir(void);
int cl_load(const char *path, struct cl_engine **engine,
unsigned int *signo, unsigned int options);
</PRE>
<code>cl_retdbdir</code> returns the default (hardcoded) path to the directory
with ClamAV databases.
<code>cl_load</code> loads a single database file or all databases from a
directory (if <code>path</code> points to a directory). The second argument
is used for passing in the engine structure which should be previously
initialized with NULL. A number of loaded signatures will be <SPAN CLASS="textbf">added</SPAN>
to <code>signo</code> <A NAME="tex2html20"
HREF="footnode.html#foot313"><SUP><SPAN CLASS="arabic">8</SPAN></SUP></A>. The last argument can pass the following flags:
<UL>
<LI><SPAN CLASS="textbf">CL_DB_STDOPT</SPAN>
<BR>
This is an alias for a recommended set of scan options.
</LI>
<LI><SPAN CLASS="textbf">CL_DB_PHISHING</SPAN>
<BR>
Load phishing signatures.
</LI>
<LI><SPAN CLASS="textbf">CL_DB_PHISHING_URLS</SPAN>
<BR>
Initialize the phishing detection module and load .wdb and .pdb files.
</LI>
<LI><SPAN CLASS="textbf">CL_DB_PUA</SPAN>
<BR>
Load signatures for Potentially Unwanted Applications.
</LI>
<LI><SPAN CLASS="textbf">CL_DB_CVDNOTMP</SPAN>
<BR>
Load CVD files directly without unpacking them into a temporary
directory.
</LI>
</UL>
<code>cl_load</code> returns 0 (<code>CL_SUCCESS</code>) on success and a negative
value on failure.
<PRE>
...
struct cl_engine *engine = NULL;
unsigned int sigs = 0;
int ret;
ret = cl_load(cl_retdbdir(), &engine, &sigs, CL_DB_STDOPT);
</PRE>
<P>
<BR><HR>
<ADDRESS>
Tomasz Kojm
2008-10-30
</ADDRESS>
</BODY>
</HTML>