File: tapi-ch1.htm

package info (click to toggle)
aolserver 3.4.2-1
links: PTS
area: main
in suites: woody
size: 22,692 kB
ctags: 33,612
sloc: ansic: 171,340; tcl: 10,218; sh: 3,821; cpp: 2,779; makefile: 2,041; yacc: 1,648; perl: 456; php: 13
file content (893 lines) | stat: -rw-r--r-- 27,115 bytes
parent folder | download | duplicates (2)
<HTML><HEAD>
<TITLE>Tcl API Reference -- Function Categories</TITLE>
<LINK rel=Previous href="tapi-ch.htm">
<LINK rel=ToC href="toc.htm">
<LINK rel=Index href="master.htm">
<LINK rel=Next href="tapi-ch2.htm">
</HEAD><BODY BGCOLOR="#ffffff"><A NAME="topofpage"></A>
<TABLE WIDTH=100%>
  <TR>
    <TD ALIGN=LEFT>
      <A NAME="topofpage"></A> <IMG  SRC="as-c-sm.gif">
    </TD>
    <TD ALIGN=RIGHT>
      <A href="tapi-ch.htm"><IMG  BORDER="0" src=navbprev.gif alt="[ Previous ]"></A>
      <A href=toc.htm> <IMG  BORDER="0" src=navbhome.gif alt="[ Contents ]"></A>
      <A href=master.htm> <IMG  BORDER="0" src=navbhelp.gif alt="[ Index ]"></A>
      <A href="tapi-ch2.htm"> <IMG  BORDER="0" src=navbnext.gif alt="[ Next ]"></A>
      <A name="7983"> </A>
    </TD>
  </TR>
</TABLE>

<a name="26836">
</a><h3>Function Categories</h3>
<p><a name="26837">
</a>The AOLserver Tcl functions are divided into four categories.  The tables below list the functions in each category.  Detailed descriptions of the functions are provided in alphabetical order in the remainder of this chapter.</p>
<a name="26845">
</a><h4>Core functions</h4>
<p><a name="49861">
</a>Core functions are available regardless of which modules are or are not loaded.<Table Border = "3">
<tr><th><p><a name="50459">
</a><b>Function</b></p>
<th><p><a name="50461">
</a><b>Description</b></p>

<tr><td><p><a name="156183">
</a><a href="tapi-ch3.htm#155774">env</a></p>
<td><p><a name="156185">
</a>Manipulate environment variables</p>

<tr><td><p><a name="176095">
</a><a href="tapi-c22.htm#179148">ns_atclose</a></p>
<td><p><a name="176097">
</a>Register a script to be executed when the current connection closes</p>

<tr><td><p><a name="226132">
</a><a href="tapi-c23.htm#225714">ns_atexit</a></p>
<td><p><a name="226134">
</a>Register a script to be run at shutdown</p>

<tr><td><p><a name="90184">
</a><a href="tapi-c24.htm#75924">ns_atshutdown</a></p>
<td><p><a name="90186">
</a>Register a script to be run at shutdown</p>

<tr><td><p><a name="90180">
</a><a href="tapi-c25.htm#87327">ns_atsignal</a></p>
<td><p><a name="90182">
</a>Register a script to be run in response to a SIGHUP signal</p>

<tr><td><p><a name="236112">
</a><a href="tapi-c26.htm#236562">ns_cache_flush</a></p>
<td><p><a name="236114">
</a>Remove cache entry</p>

<tr><td><p><a name="236116">
</a><a href="tapi-c27.htm#236563">ns_cache_names</a></p>
<td><p><a name="236118">
</a>Return cache names</p>

<tr><td><p><a name="236120">
</a><a href="tapi-c28.htm#236564">ns_cache_size</a></p>
<td><p><a name="236122">
</a>Return size of cache</p>

<tr><td><p><a name="236124">
</a><a href="tapi-c29.htm#236565">ns_cache_stats</a></p>
<td><p><a name="236126">
</a>Return cache statistics</p>

<tr><td><p><a name="175633">
</a><a href="tapi-c31.htm#207399">ns_chmod</a></p>
<td><p><a name="175635">
</a>Change a file's access permissions</p>

<tr><td><p><a name="50491">
</a><a href="tapi-c33.htm#3184">ns_config</a></p>
<td><p><a name="50493">
</a>Extract information from the configuration file</p>

<tr><td><p><a name="227023">
</a><a href="tapi-c34.htm#227106">ns_configsection</a></p>
<td><p><a name="227025">
</a>Return values of a configuration file section</p>

<tr><td><p><a name="227027">
</a><a href="tapi-c35.htm#227107">ns_configsections</a></p>
<td><p><a name="227029">
</a>Return values of all configuration file sections</p>

<tr><td><p><a name="50495">
</a><a href="tapi-c36.htm#3206">ns_conn</a></p>
<td><p><a name="50497">
</a>Find information about the HTTP connection</p>

<tr><td><p><a name="228680">
</a><a href="tapi-c37.htm#228287">ns_conncptofp</a></p>
<td><p><a name="228682">
</a>Write content to a file</p>

<tr><td><p><a name="228684">
</a><a href="tapi-c38.htm#227925">ns_connsendfp</a></p>
<td><p><a name="228686">
</a>Write contents of file to conn</p>

<tr><td><p><a name="51051">
</a><a href="tapi-c39.htm#58696">ns_cp</a></p>
<td><p><a name="51053">
</a>Copy one file to another</p>

<tr><td><p><a name="80038">
</a><a href="tapi-c40.htm#80619">ns_cpfp</a></p>
<td><p><a name="80040">
</a>Copy a specified number of bytes from one file to another</p>

<tr><td><p><a name="50499">
</a><a href="tapi-c43.htm#3386">ns_crypt</a></p>
<td><p><a name="50501">
</a>Encrypt password</p>

<tr><td><p><a name="50507">
</a><a href="tapi-c52.htm#26310">ns_eval</a></p>
<td><p><a name="50509">
</a>Evaluate Tcl (obsolete)</p>

<tr><td><p><a name="179540">
</a><a href="tapi-c56.htm#179545">ns_fmttime</a></p>
<td><p><a name="179542">
</a>Return a formatted date and time</p>

<tr><td><p><a name="175661">
</a><a href="tapi-c57.htm#174989">ns_ftruncate</a></p>
<td><p><a name="175663">
</a>Truncate an open file to a specified length</p>

<tr><td><p><a name="199426">
</a><a href="tapi-c58.htm#199439">ns_getcsv</a></p>
<td><p><a name="199428">
</a>Read CSV data from a file</p>

<tr><td><p><a name="191262">
</a><a href="tapi-c59.htm#190694">ns_getform</a></p>
<td><p><a name="191264">
</a>Return an ns_set that contains all of the query data that was part of the HTTP request</p>

<tr><td><p><a name="148680">
</a><a href="tapi-c60.htm#148702">ns_get_multipart_formdata</a></p>
<td><p><a name="148682">
</a>Handle the POST action of a form containing one file widget</p>

<tr><td><p><a name="50515">
</a><a href="tapi-c61.htm#31659">ns_geturl</a></p>
<td><p><a name="50517">
</a>Fetch a URL</p>

<tr><td><p><a name="190957">
</a><a href="tapi-c62.htm#190984">ns_gifsize</a></p>
<td><p><a name="190959">
</a>Determine the width and height of a GIF87 or GIF89 image</p>

<tr><td><p><a name="302155">
</a><a href="tapi-c63.htm#302169">ns_gmtime</a></p>
<td><p><a name="302157">
</a>Return time in GMT form</p>

<tr><td><p><a name="50519">
</a><a href="tapi-c64.htm#3596">ns_guesstype</a></p>
<td><p><a name="50521">
</a>Lookup MIME type</p>

<tr><td><p><a name="50527">
</a><a href="tapi-c66.htm#3758">ns_hrefs</a></p>
<td><p><a name="50529">
</a>Return list of HTML &lt;A&gt; links</p>

<tr><td><p><a name="106742">
</a><a href="tapi-c67.htm#68227">ns_httpget</a></p>
<td><p><a name="106744">
</a>Open an HTTP connection and fetch a page</p>

<tr><td><p><a name="106746">
</a><a href="tapi-c68.htm#107131">ns_httpopen</a></p>
<td><p><a name="106748">
</a>Open an HTTP connection</p>

<tr><td><p><a name="147346">
</a><a href="tapi-c69.htm#147715">ns_httptime</a></p>
<td><p><a name="147348">
</a>Convert time in seconds to HTTP header format</p>

<tr><td><p><a name="50531">
</a><a href="tapi-c70.htm#31528">ns_info</a></p>
<td><p><a name="50533">
</a>Find information about AOLserver</p>

<tr><td><p><a name="216817">
</a><a href="tapi-c72.htm#216570">ns_jpegsize</a></p>
<td><p><a name="216819">
</a>Determine the width and height of a JPEG image</p>

<tr><td><p><a name="229389">
</a><a href="tapi-c73.htm#229131">ns_kill</a></p>
<td><p><a name="229391">
</a>Send a signal to a process</p>

<tr><td><p><a name="80052">
</a><a href="tapi-c74.htm#81247">ns_library</a></p>
<td><p><a name="80054">
</a>Return directory for a server's Tcl library</p>

<tr><td><p><a name="175689">
</a><a href="tapi-c75.htm#175248">ns_link</a></p>
<td><p><a name="175691">
</a>Create a link</p>

<tr><td><p><a name="50535">
</a><a href="tapi-c77.htm#3844">ns_localtime</a></p>
<td><p><a name="50537">
</a>Return local time</p>

<tr><td><p><a name="50539">
</a><a href="tapi-c78.htm#32344">ns_log</a></p>
<td><p><a name="50541">
</a>Write messages to the error log</p>

<tr><td><p><a name="229423">
</a><a href="tapi-c79.htm#229429">ns_logroll</a></p>
<td><p><a name="229425">
</a>Roll server log</p>

<tr><td><p><a name="229692">
</a><a href="tapi-c80.htm#229698">ns_markfordelete</a></p>
<td><p><a name="229694">
</a>Mark interpreter for deletion</p>

<tr><td><p><a name="51055">
</a><a href="tapi-c82.htm#59915">ns_mkdir</a></p>
<td><p><a name="51057">
</a>Create a directory</p>

<tr><td><p><a name="80059">
</a><a href="tapi-c83.htm#81346">ns_mktemp</a></p>
<td><p><a name="80061">
</a>Return a unique file name based on a template</p>

<tr><td><p><a name="229957">
</a><a href="tapi-c84.htm#229969">ns_modlog</a></p>
<td><p><a name="229959">
</a>Send notice to the log</p>

<tr><td><p><a name="229961">
</a><a href="tapi-c85.htm#229970">ns_modlogcontrol</a></p>
<td><p><a name="229963">
</a>Define log realms</p>

<tr><td><p><a name="230525">
</a><a href="tapi-c86.htm#230273">ns_modulepath</a></p>
<td><p><a name="230527">
</a>Return server directory</p>

<tr><td><p><a name="51071">
</a><a href="tapi-c88.htm#65259">ns_normalizepath</a></p>
<td><p><a name="51073">
</a>Normalize a path</p>

<tr><td><p><a name="227057">
</a><a href="tapi-c89.htm#227552">ns_param</a></p>
<td><p><a name="227059">
</a>Define a parameter in the configuration file</p>

<tr><td><p><a name="230544">
</a><a href="tapi-c90.htm#230562">ns_parseheader</a></p>
<td><p><a name="230546">
</a>Parse HTTP header</p>

<tr><td><p><a name="165213">
</a><a href="tapi-c91.htm#163542">ns_parsehttptime</a></p>
<td><p><a name="165215">
</a>Return number of seconds from HTTP time</p>

<tr><td><p><a name="230548">
</a><a href="tapi-c92.htm#230777">ns_parsequery</a></p>
<td><p><a name="230550">
</a>Parse querystring</p>

<tr><td><p><a name="191266">
</a><a href="tapi-c97.htm#191284">ns_queryexists</a></p>
<td><p><a name="191268">
</a>Check for a key in the query data that was part of the HTTP request</p>

<tr><td><p><a name="191469">
</a><a href="tapi-c98.htm#191488">ns_queryget</a></p>
<td><p><a name="191471">
</a>Get a value from the query data that was part of the HTTP request</p>

<tr><td><p><a name="235725">
</a><a href="tapi-c99.htm#235507">ns_querygetall</a></p>
<td><p><a name="235727">
</a>Get multiple query values</p>

<tr><td><p><a name="50543">
</a><a href="tapi-100.htm#3909">ns_quotehtml</a></p>
<td><p><a name="50545">
</a>Escape &lt;, &gt;, and &amp; characters</p>

<tr><td><p><a name="232638">
</a><a href="tapi-101.htm#235740">ns_rand</a></p>
<td><p><a name="232640">
</a>Generate a random number</p>

<tr><td><p><a name="148219">
</a><a href="tapi-103.htm#148224">ns_register_filter</a></p>
<td><p><a name="148221">
</a>Register a filter function for a method/URL combination</p>

<tr><td><p><a name="50547">
</a><a href="tapi-104.htm#3937">ns_register_proc</a></p>
<td><p><a name="50549">
</a>Register a procedure for a URL</p>

<tr><td><p><a name="80073">
</a><a href="tapi-105.htm#81668">ns_register_trace</a></p>
<td><p><a name="80075">
</a>Register a Tcl trace script to a method and matching URL (obsolete)</p>

<tr><td><p><a name="206996">
</a><a href="tapi-106.htm#206851">ns_rename</a></p>
<td><p><a name="206998">
</a>Rename a file</p>

<tr><td><p><a name="50555">
</a><a href="tapi-107.htm#86251">ns_requestauthorize</a></p>
<td><p><a name="50557">
</a>Check permissions</p>

<tr><td><p><a name="51075">
</a><a href="tapi-108.htm#162338">ns_respond</a></p>
<td><p><a name="51077">
</a>Build a complete response</p>

<tr><td><p><a name="50559">
</a><a href="tapi-109.htm#3987">ns_return</a></p>
<td><p><a name="50561">
</a>Return information to client</p>

<tr><td><p><a name="51059">
</a><a href="tapi-110.htm#61094">ns_rmdir</a></p>
<td><p><a name="51061">
</a>Remove a directory</p>

<tr><td><p><a name="232653">
</a><a href="tapi-111.htm#235966">ns_rollfile</a></p>
<td><p><a name="232655">
</a>Roll an arbitrary file</p>

<tr><td><p><a name="200298">
</a><a href="tapi-112.htm#200308">ns_rwlock</a></p>
<td><p><a name="200300">
</a>Create, destroy, and manipulate read/write locks</p>

<tr><td><p><a name="227084">
</a><a href="tapi-116.htm#227793">ns_section</a></p>
<td><p><a name="227086">
</a>Define a section in the configuration file</p>

<tr><td><p><a name="50567">
</a><a href="tapi-118.htm#48166">ns_sendmail</a></p>
<td><p><a name="50569">
</a>Send a mail message</p>

<tr><td><p><a name="80080">
</a><a href="tapi-119.htm#193657">ns_server</a></p>
<td><p><a name="80082">
</a>Get information about a virtual server</p>

<tr><td><p><a name="50571">
</a><a href="tapi-120.htm#197598">ns_set</a></p>
<td><p><a name="50573">
</a>Manipulate sets of key-value pairs</p>

<tr><td><p><a name="147371">
</a><a href="tapi-121.htm#147921">ns_setexpires</a></p>
<td><p><a name="147373">
</a>Set Expires header</p>

<tr><td><p><a name="198508">
</a><a href="tapi-122.htm#198594">ns_set_precision</a></p>
<td><p><a name="198510">
</a>Set precision for floating-point to string conversions</p>

<tr><td><p><a name="147394">
</a><a href="tapi-123.htm#147998">ns_share</a></p>
<td><p><a name="147396">
</a>Share variable among all Tcl interpreters</p>

<tr><td><p><a name="80092">
</a><a href="tapi-124.htm#147915">ns_shutdown</a></p>
<td><p><a name="80094">
</a>Shut down the server and optionally restart it</p>

<tr><td><p><a name="50575">
</a><a href="tapi-125.htm#32708">ns_sleep</a></p>
<td><p><a name="50577">
</a>Sleep for a specified number of seconds</p>

<tr><td><p><a name="175697">
</a><a href="tapi-130.htm#175441">ns_socketpair</a></p>
<td><p><a name="175699">
</a>Create a pair of connected sockets</p>

<tr><td><p><a name="50583">
</a><a href="tapi-137.htm#32426">ns_striphtml</a></p>
<td><p><a name="50585">
</a>Remove HTML tags from a string</p>

<tr><td><p><a name="175720">
</a><a href="tapi-138.htm#175518">ns_symlink</a></p>
<td><p><a name="175722">
</a>Create a symbolic link</p>

<tr><td><p><a name="147405">
</a><a href="tapi-140.htm#148150">ns_time</a></p>
<td><p><a name="147407">
</a>Return current time in seconds</p>

<tr><td><p><a name="51067">
</a><a href="tapi-141.htm#63417">ns_tmpnam</a></p>
<td><p><a name="51069">
</a>Generate a temporary file name</p>

<tr><td><p><a name="175724">
</a><a href="tapi-142.htm#175579">ns_truncate</a></p>
<td><p><a name="175726">
</a>Truncate a file to a specified length</p>

<tr><td><p><a name="51063">
</a><a href="tapi-143.htm#62276">ns_unlink</a></p>
<td><p><a name="51065">
</a>Remove a file</p>

<tr><td><p><a name="51043">
</a><a href="tapi-144.htm#64118">ns_unregister_proc</a></p>
<td><p><a name="51045">
</a>Unregister a procedure for a URL</p>

<tr><td><p><a name="50591">
</a><a href="tapi-146.htm#4268">ns_url2file</a></p>
<td><p><a name="50593">
</a>Return file corresponding to URL</p>

<tr><td><p><a name="50595">
</a><a href="tapi-147.htm#32587">ns_urldecode</a></p>
<td><p><a name="50597">
</a>Decode characters</p>

<tr><td><p><a name="50599">
</a><a href="tapi-148.htm#32604">ns_urlencode</a></p>
<td><p><a name="50601">
</a>Encode characters in a URL</p>

<tr><td><p><a name="225586">
</a><a href="tapi-149.htm#225620">ns_uudecode</a></p>
<td><p><a name="225588">
</a>Perform base-64 decode</p>

<tr><td><p><a name="225590">
</a><a href="tapi-150.htm#225621">ns_uuencode</a></p>
<td><p><a name="225592">
</a>Perform base-64 encode</p>

<tr><td><p><a name="50603">
</a><a href="tapi-151.htm#32524">ns_write</a></p>
<td><p><a name="50605">
</a>Write raw content back to the client</p>

<tr><td><p><a name="50607">
</a><a href="tapi-152.htm#33391">ns_writecontent</a></p>
<td><p><a name="50609">
</a>Write content to a file</p>

<tr><td><p><a name="198559">
</a><a href="tapi-153.htm#198728">ns_writefp</a></p>
<td><p><a name="198561">
</a>Write file contents to the connection</p>


</Table></p>
<a name="80097">
</a><h4>ADP functions</h4>
<p><a name="143715">
</a>These functions are for use within AOLserver Dynamic Pages (ADPs):<Table Border = "3">
<tr><th><p><a name="143684">
</a><b>Function</b></p>
<th><p><a name="143686">
</a><b>Description</b></p>

<tr><td><p><a name="143691">
</a><a href="tapi-ch4.htm#145894">ns_adp_abort</a></p>
<td><p><a name="143693">
</a>Stop processing of ADP and throw away all output</p>

<tr><td><p><a name="200703">
</a><a href="tapi-ch5.htm#205037">ns_adp_argc</a></p>
<td><p><a name="200705">
</a>Return number of ADP arguments</p>

<tr><td><p><a name="200707">
</a><a href="tapi-ch6.htm#205045">ns_adp_argv</a></p>
<td><p><a name="200709">
</a>Return ADP argument values</p>

<tr><td><p><a name="200676">
</a><a href="tapi-ch7.htm#205053">ns_adp_bind_args</a></p>
<td><p><a name="200678">
</a>Bind ADP arguments to names</p>

<tr><td><p><a name="143698">
</a><a href="tapi-ch8.htm#200736">ns_adp_break</a></p>
<td><p><a name="143700">
</a>Stop processing of ADP and flush all output</p>

<tr><td><p><a name="223692">
</a><a href="tapi-ch9.htm#222048">ns_adp_debug</a></p>
<td><p><a name="223694">
</a>Connect to TclPro debugger</p>

<tr><td><p><a name="143705">
</a><a href="tapi-c10.htm#146426">ns_adp_dir</a></p>
<td><p><a name="143707">
</a>Return directory where ADP resides</p>

<tr><td><p><a name="223712">
</a><a href="tapi-c11.htm#222437">ns_adp_dump</a></p>
<td><p><a name="223714">
</a>Return ADP output buffer</p>

<tr><td><p><a name="223716">
</a><a href="tapi-c12.htm#222438">ns_adp_eval</a></p>
<td><p><a name="223718">
</a>Evaluate ADP</p>

<tr><td><p><a name="223720">
</a><a href="tapi-c13.htm#222439">ns_adp_exception</a></p>
<td><p><a name="223722">
</a>Return ADP exception state</p>

<tr><td><p><a name="143712">
</a><a href="tapi-c14.htm#146692">ns_adp_include</a></p>
<td><p><a name="143714">
</a>Write contents of file to page</p>

<tr><td><p><a name="144008">
</a><a href="tapi-c15.htm#145624">ns_adp_parse</a></p>
<td><p><a name="144010">
</a>Process an ADP file and return the result as a string</p>

<tr><td><p><a name="144031">
</a><a href="tapi-c16.htm#222875">ns_adp_puts</a></p>
<td><p><a name="144033">
</a>Write string or Tcl command output to page</p>

<tr><td><p><a name="223746">
</a><a href="tapi-c17.htm#221672">ns_adp_registertag</a></p>
<td><p><a name="223748">
</a>Register an ADP tag</p>

<tr><td><p><a name="297073">
</a><a href="tapi-c18.htm#296668">ns_adp_return</a></p>
<td><p><a name="297075">
</a>Stop processing of ADP and flush all output</p>

<tr><td><p><a name="223750">
</a><a href="tapi-c19.htm#223254">ns_adp_stream</a></p>
<td><p><a name="223752">
</a>Begin ADP streaming</p>

<tr><td><p><a name="223754">
</a><a href="tapi-c20.htm#287015">ns_adp_tell</a></p>
<td><p><a name="223756">
</a>Return bytes in ADP output buffer</p>

<tr><td><p><a name="223758">
</a><a href="tapi-c21.htm#287024">ns_adp_trunc</a></p>
<td><p><a name="223760">
</a>Clear ADP output buffer</p>

<tr><td><p><a name="174150">
</a><a href="tapi-102.htm#173981">ns_register_adptag</a></p>
<td><p><a name="174152">
</a>Register a tag for use within an ADP</p>


</Table></p>
<a name="143672">
</a><h4>Control port interface functions</h4>
<p><a name="295950">
</a>This function is available for use within the control port interface:<Table Border = "3">
<tr><th><p><a name="295919">
</a><b>Function</b></p>
<th><p><a name="295921">
</a><b>Description</b></p>

<tr><td><p><a name="295926">
</a><a href="tapi-c41.htm#228736">ns_cport</a></p>
<td><p><a name="295928">
</a>Control port interface commands</p>

<tr><td><p><a name="300758">
</a><a href="tapi-c81.htm#300772">ns_menu</a></p>
<td><p><a name="300760">
</a>Administer server in control port</p>


</Table></p>
<p><a name="295913">
</a></p>
<a name="295912">
</a><h4>Scheduled procedures</h4>
<p><a name="80098">
</a>These functions allow you to specify a Tcl script to be run daily, weekly, or at specified intervals.<Table Border = "3">
<tr><th><p><a name="80101">
</a><b>Function</b></p>
<th><p><a name="80103">
</a><b>Description</b></p>

<tr><td><p><a name="80108">
</a><a href="tapi-113.htm#81743">ns_schedule_daily</a></p>
<td><p><a name="80110">
</a>Schedule a procedure to run once a day</p>

<tr><td><p><a name="80115">
</a><a href="tapi-114.htm#81770">ns_schedule_proc</a></p>
<td><p><a name="80117">
</a>Schedule a procedure to run at specified intervals</p>

<tr><td><p><a name="80122">
</a><a href="tapi-115.htm#81782">ns_schedule_weekly</a></p>
<td><p><a name="80124">
</a>Schedule a procedure to run once a week</p>

<tr><td><p><a name="80129">
</a><a href="tapi-145.htm#82663">ns_unschedule_proc</a></p>
<td><p><a name="80131">
</a>Stop a scheduled procedure</p>


</Table></p>
<a name="166851">
</a><h4>Sockets interface</h4>
<p><a name="80188">
</a>The following functions are available for managing sockets:<Table Border = "3">
<tr><th><p><a name="80136">
</a><b>Function</b></p>
<th><p><a name="80138">
</a><b>Description</b></p>

<tr><td><p><a name="80143">
</a><a href="tapi-c65.htm#81032">ns_hostbyaddr</a></p>
<td><p><a name="80145">
</a>Resolve an IP address to a hostname</p>

<tr><td><p><a name="80150">
</a><a href="tapi-126.htm#82156">ns_sockaccept</a></p>
<td><p><a name="80152">
</a>Accept a new socket connection</p>

<tr><td><p><a name="232668">
</a><a href="tapi-127.htm#232740">ns_sockblocking</a></p>
<td><p><a name="232670">
</a>Set socket blocking</p>

<tr><td><p><a name="80157">
</a><a href="tapi-128.htm#82176">ns_sockcallback</a></p>
<td><p><a name="80159">
</a>Register a socket callback script</p>

<tr><td><p><a name="80164">
</a><a href="tapi-129.htm#82223">ns_sockcheck</a></p>
<td><p><a name="80166">
</a>Check if a socket is connected</p>

<tr><td><p><a name="80171">
</a><a href="tapi-135.htm#82248">ns_sockopen</a></p>
<td><p><a name="80173">
</a>Create a socket listening for connections</p>

<tr><td><p><a name="232688">
</a><a href="tapi-132.htm#232820">ns_socklistencallback</a></p>
<td><p><a name="232690">
</a>Run script on connection</p>

<tr><td><p><a name="232711">
</a><a href="tapi-133.htm#232894">ns_socknonblocking</a></p>
<td><p><a name="232713">
</a>Set socket nonblocking</p>

<tr><td><p><a name="232715">
</a><a href="tapi-134.htm#232969">ns_socknread</a></p>
<td><p><a name="232717">
</a>Return bytes to be read</p>

<tr><td><p><a name="80178">
</a><a href="tapi-135.htm#82248">ns_sockopen</a></p>
<td><p><a name="80180">
</a>Connect to a remote host on the specified port</p>

<tr><td><p><a name="80185">
</a><a href="tapi-136.htm#82277">ns_sockselect</a></p>
<td><p><a name="80187">
</a>Determine readable file id's</p>


</Table></p>
<a name="80226">
</a><h4>Threads interface</h4>
<p><a name="80267">
</a>The following functions are available for managing threads and thread synchronozation objects:<Table Border = "3">
<tr><th><p><a name="80229">
</a><b>Function</b></p>
<th><p><a name="80231">
</a><b>Description</b></p>

<tr><td><p><a name="227000">
</a><a href="tapi-c32.htm#226592">ns_cond</a></p>
<td><p><a name="227002">
</a>Manage events</p>

<tr><td><p><a name="80236">
</a><a href="tapi-c42.htm#80760">ns_critsec</a></p>
<td><p><a name="80238">
</a>Manage critical sections</p>

<tr><td><p><a name="80243">
</a><a href="tapi-c53.htm#80907">ns_event</a></p>
<td><p><a name="80245">
</a>Manage events</p>

<tr><td><p><a name="80250">
</a><a href="tapi-c87.htm#81432">ns_mutex</a></p>
<td><p><a name="80252">
</a>Manage mutexes</p>

<tr><td><p><a name="80257">
</a><a href="tapi-117.htm#81850">ns_sema</a></p>
<td><p><a name="80259">
</a>Manage semaphores</p>

<tr><td><p><a name="80264">
</a><a href="tapi-139.htm#82563">ns_thread</a></p>
<td><p><a name="80266">
</a>Manage threads</p>


</Table></p>
<a name="26854">
</a><h4>Permissions functions</h4>
<p><a name="55200">
</a>Permissions functions are available only when the nsperm module is loaded.  See <a href="acc-ch.htm#2692">Chapter 6</a> for information on the access control system.  Note that the entire user interface for the access control system is implemented in Tcl.  Follow the nsperm link on the Tcl Script Maintenance page to see the scripts..<Table Border = "3">
<tr><th><p><a name="50369">
</a><b>Function</b></p>
<th><p><a name="50371">
</a><b>Description</b></p>

<tr><td><p><a name="226168">
</a><b><a href="tapi-c30.htm#226180"></b>ns_checkurl<b></a></b></p>
<td><p><a name="226170">
</a>Authorize a request</p>

<tr><td><p><a name="297394">
</a><b><a href="tapi-c93.htm#297155"></b>ns_passwordcheck<b></a></b></p>
<td><p><a name="297396">
</a>Verify a user/password combination</p>

<tr><td><p><a name="78438">
</a><b><a href="tapi-c94.htm#79412"></b>ns_perm<b></a></b></p>
<td><p><a name="78440">
</a>Add users, groups, and permissions</p>

<tr><td><p><a name="296274">
</a><b><a href="tapi-c95.htm#296291"></b>ns_permpasswd<b></a></b></p>
<td><p><a name="296276">
</a>Update existing password</p>


</Table></p>
<a name="26859">
</a><h4>Database Services functions</h4>
<p><a name="49865">
</a>Database services functions are available only when the nsdb module is loaded.<Table Border = "3">
<tr><th><p><a name="50023">
</a><b>Function</b></p>
<th><p><a name="50025">
</a><b>Description</b></p>

<tr><td><p><a name="75587">
</a><a href="tapi-c44.htm#67537">ns_db</a></p>
<td><p><a name="75592">
</a>Access the AOLserver database</p>

<tr><td><p><a name="75597">
</a><a href="tapi-c45.htm#67905">ns_dbconfigpath</a></p>
<td><p><a name="75599">
</a>Get nsdb section name</p>

<tr><td><p><a name="75604">
</a><a href="tapi-c46.htm#67914">ns_dberror</a></p>
<td><p><a name="75606">
</a>Return SQL error information</p>

<tr><td><p><a name="75417">
</a><a href="tapi-c47.htm#77098">ns_dbformvalue</a></p>
<td><p><a name="75419">
</a>Retrieve the value of a column specified by form data</p>

<tr><td><p><a name="75410">
</a><a href="tapi-c48.htm#77112">ns_dbformvalueput</a></p>
<td><p><a name="75412">
</a>Set default values in an HTML form for accessing the database</p>

<tr><td><p><a name="75403">
</a><a href="tapi-c49.htm#77217">ns_dbquotename</a></p>
<td><p><a name="75405">
</a>Surround a name by double quotes if it contains a space</p>

<tr><td><p><a name="75396">
</a><a href="tapi-c50.htm#77226">ns_dbquotevalue</a></p>
<td><p><a name="75398">
</a>Prepare a value string for inclusion in an SQL statement</p>

<tr><td><p><a name="75389">
</a><a href="tapi-c51.htm#77349">ns_deleterow</a></p>
<td><p><a name="75391">
</a>Delete row in specified table corresponding to form data</p>

<tr><td><p><a name="75361">
</a><a href="tapi-c54.htm#82709">ns_ext</a></p>
<td><p><a name="75363">
</a>Send information to the database proxy daemon</p>

<tr><td><p><a name="75354">
</a><a href="tapi-c55.htm#77814">ns_findrowbyid</a></p>
<td><p><a name="75356">
</a>Return row corresponding to specified key/value pairs</p>

<tr><td><p><a name="75347">
</a><a href="tapi-c71.htm#167015">ns_insertrow</a></p>
<td><p><a name="75349">
</a>Insert form data into specified table as a new row</p>

<tr><td><p><a name="75340">
</a><a href="tapi-c76.htm#77999">ns_localsqltimestamp</a></p>
<td><p><a name="75342">
</a>Return a SQL timestamp containing the local time</p>

<tr><td><p><a name="75625">
</a><a href="tapi-c96.htm#147140">ns_pooldescription</a></p>
<td><p><a name="75627">
</a>Get database pool description</p>


</Table></p>


<TABLE BORDER="2" CELLPADDING="1" width="100%">
<TR><TD COLSPAN=3><P ALIGN=Center>
<IMG SRC="bluebult.gif">
<A HREF="#topofpage">
<FONT SIZE=-1>Top of Page</FONT></A>
<IMG SRC="bluebult.gif">
</TD></TR>
<TR><TD COLSPAN=3><P ALIGN=Center>
<A href="tapi-ch.htm">
<IMG  BORDER="0" src=navbprev.gif alt="[ Previous ]"></A>
<A href=toc.htm>
<IMG  BORDER="0" src=navbhome.gif alt="[ Contents ]"></A>
<A href=master.htm>
<IMG  BORDER="0" src=navbhelp.gif alt="[ Index ]"></A>
<A href="tapi-ch2.htm">
<IMG  BORDER="0" src=navbnext.gif alt="[ Next ]"></A>
<BR align=center>
<FONT size=-1>Copyright &copy; 1998-99 America Online,
Inc.</FONT>
</TD></TR></TABLE></BODY></HTML>