<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <HTML ><HEAD ><TITLE >UdmAgentInit</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK REL="HOME" TITLE="mnoGoSearch 3.3.9 reference manual" HREF="index.html"><LINK REL="UP" TITLE="mnoGoSearch C API function reference" HREF="msearch-c-api.html"><LINK REL="PREVIOUS" TITLE="UdmEnvFree" HREF="msearch-c-api-udmenvfree.html"><LINK REL="NEXT" TITLE="UdmAgentFree" HREF="msearch-c-api-udmagentfree.html"><LINK REL="STYLESHEET" TYPE="text/css" HREF="mnogo.css"><META NAME="Description" CONTENT="mnoGoSearch - Full Featured Web site Open Source Search Engine Software over the Internet and Intranet Web Sites Based on SQL Database. It is a Free search software covered by GNU license."><META NAME="Keywords" CONTENT="shareware, freeware, download, internet, unix, utilities, search engine, text retrieval, knowledge retrieval, text search, information retrieval, database search, mining, intranet, webserver, index, spider, filesearch, meta, free, open source, full-text, udmsearch, website, find, opensource, search, searching, software, udmsearch, engine, indexing, system, web, ftp, http, cgi, php, SQL, MySQL, database, php3, FreeBSD, Linux, Unix, mnoGoSearch, MacOS X, Mac OS X, Windows, 2000, NT, 95, 98, GNU, GPL, url, grabbing"></HEAD ><BODY CLASS="refentry" BGCOLOR="#EEEEEE" TEXT="#000000" LINK="#000080" VLINK="#800080" ALINK="#FF0000" ><!--#include virtual="body-before.html"--><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" ><SPAN CLASS="application" >mnoGoSearch</SPAN > 3.3.9 reference manual: Full-featured search engine software</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="msearch-c-api-udmenvfree.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="msearch-c-api-udmagentfree.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="c-api-UdmAgentInit" ></A >UdmAgentInit</H1 ><DIV CLASS="refnamediv" ><A NAME="AEN14154" ></A ><H2 >Name</H2 >UdmAgentInit -- Allocates or initializes a search session variable</DIV ><DIV CLASS="refsect1" ><A NAME="AEN14157" ></A ><H2 >Description</H2 ><code class="methodsynopsis" > <span class="type" >UDM_AGENT* </span >UdmAgentInit(<span class="methodparam" ><span class="type" >UDM_AGENT* </span ><span class="parameter" >Agent</span ></span ><span class="methodparam" >, <span class="type" >UDM_ENV* </span ><span class="parameter" >Env</span ></span ><span class="methodparam" >, <span class="type" >int </span ><span class="parameter" >id</span ></span >); </code ><P > Allocates or initializes an <SPAN CLASS="type" >UDM_AGENT</SPAN > variable (search session). </P ><P > If <CODE CLASS="parameter" >Agent</CODE > is a <TT CLASS="literal" >NULL</TT > pointer, the function allocates, initializes, and returns a new variable. Otherwise, the variable is initialized and the address of the variable is returned. If <CODE CLASS="function" >UdmAgentInit()</CODE > allocates a new variable, it is freed when <CODE CLASS="function" >UdmAgentFree()</CODE > is called to close search session. </P ></DIV ><DIV CLASS="refsect1" ><A NAME="AEN14178" ></A ><H2 >Parameters</H2 ><P > <P ></P ><DIV CLASS="variablelist" ><DL ><DT ><CODE CLASS="parameter" >Agent</CODE ></DT ><DD ><P > Pointer to a variable of type <SPAN CLASS="type" >UDM_AGENT</SPAN >. </P ></DD ><DT ><CODE CLASS="parameter" >Env</CODE ></DT ><DD ><P > Pointer to a variable of type <SPAN CLASS="type" >UDM_ENV</SPAN >, should be the address of an existing <SPAN CLASS="type" >UDM_ENV</SPAN > structure. Before calling <CODE CLASS="function" >UdmAgentInit()</CODE > you must previously call <CODE CLASS="function" >UdmEnvInit()</CODE > to initialize the <SPAN CLASS="type" >UDM_ENV</SPAN > structure. </P ></DD ><DT ><CODE CLASS="parameter" >id</CODE ></DT ><DD ><P > Thread id - an unique positive integer for a multi-thread application, or <TT CLASS="literal" >0</TT > in a non-thread application. </P ></DD ></DL ></DIV > </P ></DIV ><DIV CLASS="refsect1" ><A NAME="AEN14204" ></A ><H2 >Return Values</H2 ><P > Pointer to initialized <SPAN CLASS="type" >UDM_AGENT</SPAN > variable on success, or <TT CLASS="literal" >NULL</TT > if there was insufficient memory to allocate a new variable. </P ></DIV ><DIV CLASS="refsect1" ><A NAME="AEN14209" ></A ><H2 >Examples</H2 ><P > <DIV CLASS="example" ><A NAME="AEN14212" ></A ><P ><B >Example 1. <CODE CLASS="function" >UdmAgentInit</CODE > example #1</B ></P ><PRE CLASS="programlisting" > UDM_AGENT *Agent; if (!(Agent= UdmAgentInit(NULL, Env, 0))) { printf('Fatal error: could not allocate Agent'); exit(1); } ... UdmAgentFree(Agent); </PRE ></DIV > </P ><P > <DIV CLASS="example" ><A NAME="AEN14217" ></A ><P ><B >Example 2. <CODE CLASS="function" >UdmAgentInit</CODE > example #2</B ></P ><PRE CLASS="programlisting" > UDM_AGENT Agent; if (!UdmEnvInit(&Agent)) { printf('Fatal error: could not initialize Agent'); exit(1); } ... UdmAgentFree(&Agent); </PRE ></DIV > </P ></DIV ><DIV CLASS="refsect1" ><A NAME="AEN14221" ></A ><H2 >Notes</H2 ><P > In a multi-threaded application, multiple search session variables can share the same search context variable. </P ></DIV ><DIV CLASS="refsect1" ><A NAME="AEN14224" ></A ><H2 >See Also</H2 ><P > <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD ><CODE CLASS="function" ><A HREF="msearch-c-api-udmenvinit.html" >UdmEnvInit</A ></CODE ></TD ></TR ><TR ><TD ><CODE CLASS="function" ><A HREF="msearch-c-api-udmenvfree.html" >UdmEnvFree</A ></CODE ></TD ></TR ><TR ><TD ><CODE CLASS="function" ><A HREF="msearch-c-api-udmagentfree.html" >UdmAgentFree</A ></CODE ></TD ></TR ></TBODY ></TABLE ><P ></P > </P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="msearch-c-api-udmenvfree.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="msearch-c-api-udmagentfree.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >UdmEnvFree</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="msearch-c-api.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >UdmAgentFree</TD ></TR ></TABLE ></DIV ><!--#include virtual="body-after.html"--></BODY ></HTML >