clamav/docs/html/node39.html

118 lines
3.6 KiB
HTML
Raw Normal View History

2008-03-03 19:11:41 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2008-03-03 19:11:41 +00:00
<!--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>
2007-10-08 19:22:34 +00:00
<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">
2008-03-03 19:11:41 +00:00
<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="node40.html">
<LINK REL="previous" HREF="node38.html">
2007-10-08 19:22:34 +00:00
<LINK REL="up" HREF="node37.html">
<LINK REL="next" HREF="node40.html">
</HEAD>
<BODY >
2008-03-03 19:11:41 +00:00
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html700"
HREF="node40.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
2008-03-03 19:11:41 +00:00
<A NAME="tex2html696"
2007-10-08 19:22:34 +00:00
HREF="node37.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
2008-03-03 19:11:41 +00:00
<A NAME="tex2html690"
HREF="node38.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
2008-03-03 19:11:41 +00:00
<A NAME="tex2html698"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
2008-03-03 19:11:41 +00:00
<B> Next:</B> <A NAME="tex2html701"
2007-10-08 19:22:34 +00:00
HREF="node40.html">Error handling</A>
2008-03-03 19:11:41 +00:00
<B> Up:</B> <A NAME="tex2html697"
2007-10-08 19:22:34 +00:00
HREF="node37.html">API</A>
2008-03-03 19:11:41 +00:00
<B> Previous:</B> <A NAME="tex2html691"
2007-10-08 19:22:34 +00:00
HREF="node38.html">Header file</A>
2008-03-03 19:11:41 +00:00
&nbsp; <B> <A NAME="tex2html699"
HREF="node1.html">Contents</A></B>
<BR>
2008-03-03 19:11:41 +00:00
<BR></DIV>
<!--End of Navigation Panel-->
2007-10-08 19:22:34 +00:00
<H3><A NAME="SECTION00073200000000000000">
Database loading</A>
</H3>
2007-10-08 19:22:34 +00:00
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
2008-03-03 19:11:41 +00:00
initialized with NULL. A number of loaded signatures will be <SPAN CLASS="textbf">added</SPAN>
2007-10-08 19:22:34 +00:00
to <code>signo</code> <A NAME="tex2html15"
2008-03-18 15:40:41 +00:00
HREF="footnode.html#foot291"><SUP><SPAN CLASS="arabic">7</SPAN></SUP></A>. The last argument can pass the following flags:
2007-10-08 19:22:34 +00:00
<UL>
2008-03-03 19:11:41 +00:00
<LI><SPAN CLASS="textbf">CL_DB_STDOPT</SPAN>
2007-10-08 19:22:34 +00:00
<BR>
This is an alias for a recommended set of scan options.
</LI>
2008-03-03 19:11:41 +00:00
<LI><SPAN CLASS="textbf">CL_DB_PHISHING</SPAN>
2007-10-08 19:22:34 +00:00
<BR>
Load phishing signatures.
</LI>
2008-03-03 19:11:41 +00:00
<LI><SPAN CLASS="textbf">CL_DB_PHISHING_URLS</SPAN>
2007-10-08 19:22:34 +00:00
<BR>
Initialize the phishing detection module and load .wdb and .pdb files.
2008-03-18 15:40:41 +00:00
</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.
2007-10-08 19:22:34 +00:00
</LI>
</UL>
2008-03-18 15:40:41 +00:00
<code>cl_load</code> returns 0 (<code>CL_SUCCESS</code>) on success and a negative
2007-10-08 19:22:34 +00:00
value on failure.
<PRE>
2007-10-08 19:22:34 +00:00
...
struct cl_engine *engine = NULL;
unsigned int sigs = 0;
int ret;
ret = cl_load(cl_retdbdir(), &amp;engine, &amp;sigs, CL_DB_STDOPT);
</PRE>
<P>
<BR><HR>
<ADDRESS>
Tomasz Kojm
2008-04-09
</ADDRESS>
</BODY>
</HTML>