<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> <!--NewPage--> <HTML> <HEAD> <!-- Generated by PhpDoc date: 'Mon, 11 Nov 2002 23:46:24 +0100' --> <TITLE>Docs For Class Dir</TITLE> <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> </HEAD> <BODY BGCOLOR='white'> <!-- Start of Class Data --> <H2> Class Dir </H2> <pre> <pre><a href="../core/Object.html">Object</a> | --Dir</pre> </pre> <H3> Classes extended from Dir: </H3> <p> <b><i>Located in File: Program_Root/dir.inc.php</i></b><br> </p> <hr> <!-- ========== Info from phpDoc block ========= --> <b>Directory manipulation class.</b> <pre> Dir class id used for creating, opening, closing and removing directories. </pre> <UL> <LI><b>Package</b> - <CODE>io</CODE></LI> <LI><b>Version</b> - <CODE>$Id: Dir.html,v 1.2 2002/11/28 09:43:11 rbala Exp $</CODE></LI> <LI><b>Access</b> - <CODE>public</CODE></LI> <LI><b>Author</b> - <CODE>Robert Bala <<a href="mailto:hide@address.com">hide@address.com</a>></CODE></LI> </UL> <hr> <!-- =========== VAR SUMMARY =========== --> <A NAME='var_summary'><!-- --></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Class Variable Summary</B></FONT> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#$_handle'>$_handle</A></B></CODE> <BR> <blockquote> Directory handle. </blockquote> <blockquote> Default Value: <CODE>-><-</CODE> </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#$_root'>$_root</A></B></CODE> <BR> <blockquote> Directory path. </blockquote> <blockquote> Default Value: <CODE>-><-</CODE> </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#$_status'>$_status</A></B></CODE> <BR> <blockquote> Information about the directory - size, creation date etc . </blockquote> <blockquote> Default Value: <CODE>-><-</CODE> </blockquote> </TD> </TR> </TABLE> <hr> <!-- =========== VAR SUMMARY =========== --> <A NAME='var_summary'><!-- --></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Inherited Class Variable Summary</B></FONT> </TD> </TR> </TABLE> <hr> <!-- =========== INHERITED METHOD SUMMARY =========== --> <A NAME='functions_inherited'><!-- --></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Inherited Method Summary</B></FONT> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <FONT SIZE='+2'><B>Inherited From Class <a href="../core/Object.html">Object</a></B></FONT> <blockquote> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='95%'> <tr> <th>Function</th> <th>Description</th> </tr> <tr> <td><CODE><B><A HREF='../core/Object.html#constructor Object'>constructor Object ( )</A></B></CODE></td> <td>Object class constructor.</td> <tr> <td><CODE><B><A HREF='../core/Object.html#classMethods'>classMethods ( )</A></B></CODE></td> <td>Retrieves the class methods names of the object.</td> <tr> <td><CODE><B><A HREF='../core/Object.html#className'>className ( )</A></B></CODE></td> <td>Retrieves the name of the class of the object.</td> <tr> <td><CODE><B><A HREF='../core/Object.html#classParent'>classParent ( )</A></B></CODE></td> <td>Retrieves the parent class name for the object.</td> <tr> <td><CODE><B><A HREF='../core/Object.html#classProperties'>classProperties ( )</A></B></CODE></td> <td>Retrieves the class properties names of the object.</td> <tr> <td><CODE><B><A HREF='../core/Object.html#inheritsFrom'>inheritsFrom ( [$class = ] )</A></B></CODE></td> <td>Check if the objects inherits from the specified class.</td> </table> </blockquote> </TD> </TR> </TABLE> <br> <!-- should have constructor at some point --> <!-- =========== Method SUMMARY =========== --> <A NAME='Method_summary'><!-- --></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Method Summary</B></FONT> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#constructor Dir'>void constructor Dir ( [$root = './'] )</A></B></CODE> <BR> <blockquote> Dir class constructor. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#close'>mixed close ( )</A></B></CODE> <BR> <blockquote> Closes the directory. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#create'>mixed create ( $path, [$mode = 0755] )</A></B></CODE> <BR> <blockquote> Attempts to create the subdirectory. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#delete'>mixed delete ( )</A></B></CODE> <BR> <blockquote> Attempts to remove the directory. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#exists'>boolean exists ( )</A></B></CODE> <BR> <blockquote> Checks whether a directory exists. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#fileCount'>mixed fileCount ( )</A></B></CODE> <BR> <blockquote> Retrieves the number of files. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#fileNames'>mixed fileNames ( )</A></B></CODE> <BR> <blockquote> Retrieves the list of file names. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#getGroup'>mixed getGroup ( )</A></B></CODE> <BR> <blockquote> Gets the group ID of the owner of the directory. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#getHandle'>mixed getHandle ( )</A></B></CODE> <BR> <blockquote> Gets the directory handle. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#dirNames'>mixed dirNames ( )</A></B></CODE> <BR> <blockquote> Retrieves the list of subdirectory names. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#getOwner'>mixed getOwner ( )</A></B></CODE> <BR> <blockquote> Gets the user ID of the owner of the directory. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#getRoot'>string getRoot ( )</A></B></CODE> <BR> <blockquote> Gets the directory path. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#isOpened'>boolean isOpened ( )</A></B></CODE> <BR> <blockquote> Finds whether the directory is opened. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#isReadable'>boolean isReadable ( )</A></B></CODE> <BR> <blockquote> Finds whether the directory is readable. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#isWriteable'>boolean isWriteable ( )</A></B></CODE> <BR> <blockquote> Finds whether the directory is writeable. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#dirCount'>mixed dirCount ( )</A></B></CODE> <BR> <blockquote> Retrieves the number of subdirectories. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#open'>mixed open ( )</A></B></CODE> <BR> <blockquote> Opens the directory. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#read'>mixed read ( [$asc = true] )</A></B></CODE> <BR> <blockquote> Read list of files and subdirectories. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#readDirs'>mixed readDirs ( [$asc = true] )</A></B></CODE> <BR> <blockquote> Read list of subdirectories. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#readFiles'>mixed readFiles ( [$asc = true] )</A></B></CODE> <BR> <blockquote> Read list of files. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#remove'>mixed remove ( $path )</A></B></CODE> <BR> <blockquote> Attempts to remove the subdirectory or file. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='Dir.html#rename'>mixed rename ( $path )</A></B></CODE> <BR> <blockquote> Attempts to rename the subdirectory or file. </blockquote> </TD> </TR> </TABLE> <hbr> <!-- ============ VARIABLE DETAIL =========== --> <A NAME='variable_detail'></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Variable Detail</B></FONT> </TD> </TR> </TABLE> <A NAME='$_handle'><!-- --></A><H3>$_handle</H3> <b>Data type:</b> mixed<br> <!-- ========== Info from phpDoc block ========= --> <b>Directory handle.</b> <pre> </pre> <UL> <LI><b>Access</b> - <CODE>private</CODE></LI> </UL> <HR> <A NAME='$_root'><!-- --></A><H3>$_root</H3> <b>Data type:</b> string<br> <!-- ========== Info from phpDoc block ========= --> <b>Directory path.</b> <pre> </pre> <UL> <LI><b>Access</b> - <CODE>private</CODE></LI> </UL> <HR> <A NAME='$_status'><!-- --></A><H3>$_status</H3> <b>Data type:</b> array<br> <!-- ========== Info from phpDoc block ========= --> <b>Information about the directory - size, creation date etc .</b> <pre> </pre> <UL> <LI><b>Access</b> - <CODE>private</CODE></LI> </UL> <HR> <hr> <!-- ============ FUNCTION DETAIL =========== --> <A NAME='function_detail'></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Method Detail</B></FONT> </TD> </TR> </TABLE> <A NAME='constructor Dir'><!-- --></A><H3>constructor Dir</H3> <P><B>void constructor Dir ( [$root = './'] )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Dir class constructor.</b> <pre> Creates the new instance of Dir class and sets up basic properties. </pre> <DL> <DT>Function Parameters:</DT> <DD><CODE>- <i>string $root</i>: the path to directory, defaults to "./".</CODE></DD> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='close'><!-- --></A><H3>close</H3> <P><B>mixed close ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Closes the directory.</b> <pre> If called when the directory is closed or it couldn't be closed, it returns error object, otherwise it returns true. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='create'><!-- --></A><H3>create</H3> <P><B>mixed create ( $path, [$mode = 0755] )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Attempts to create the subdirectory.</b> <pre> Returns true on success or error object with an error message on any kind of failure. </pre> <DL> <DT>Function Parameters:</DT> <DD><CODE>- <i>string $path</i>: the path where to create the subdirectory.</CODE></DD> <DD><CODE>- <i>int $mode</i>: the access permissions, defaults to 0755.</CODE></DD> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='delete'><!-- --></A><H3>delete</H3> <P><B>mixed delete ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Attempts to remove the directory.</b> <pre> If called when the directory is already opened, it returns error object otherwise it returns true on success or error object with an error message on any kind of failure. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='exists'><!-- --></A><H3>exists</H3> <P><B>boolean exists ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Checks whether a directory exists.</b> <pre> Returns true if the directory exists, false otherwise. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='fileCount'><!-- --></A><H3>fileCount</H3> <P><B>mixed fileCount ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Retrieves the number of files.</b> <pre> If called when the directory is not opened, it returns error object otherwise it returns number of files. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='fileNames'><!-- --></A><H3>fileNames</H3> <P><B>mixed fileNames ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Retrieves the list of file names.</b> <pre> If called when the directory is not opened, it returns error object otherwise it returns array with file names contained in the directory. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='getGroup'><!-- --></A><H3>getGroup</H3> <P><B>mixed getGroup ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Gets the group ID of the owner of the directory.</b> <pre> If called when the directory is closed it returns error object, otherwise it returns the group ID of the owner of the directory in numerical format. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='getHandle'><!-- --></A><H3>getHandle</H3> <P><B>mixed getHandle ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Gets the directory handle.</b> <pre> Returns resource handle if the directory is opened, null otherwise. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='dirNames'><!-- --></A><H3>dirNames</H3> <P><B>mixed dirNames ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Retrieves the list of subdirectory names.</b> <pre> If called when the directory is not opened, it returns error object otherwise it returns array with subdirectory names contained in the directory. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='getOwner'><!-- --></A><H3>getOwner</H3> <P><B>mixed getOwner ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Gets the user ID of the owner of the directory.</b> <pre> If called when the directory is closed it returns error object, otherwise it returns the user ID of the owner of the directory in numerical format. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='getRoot'><!-- --></A><H3>getRoot</H3> <P><B>string getRoot ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Gets the directory path.</b> <pre> Returns the directory path or empty string if the path has not been set in object constructor. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='isOpened'><!-- --></A><H3>isOpened</H3> <P><B>boolean isOpened ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Finds whether the directory is opened.</b> <pre> Returns true if the directory is opened, false otherwise. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='isReadable'><!-- --></A><H3>isReadable</H3> <P><B>boolean isReadable ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Finds whether the directory is readable.</b> <pre> Returns true if the directory exists and is readable, false otherwise. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='isWriteable'><!-- --></A><H3>isWriteable</H3> <P><B>boolean isWriteable ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Finds whether the directory is writeable.</b> <pre> Returns true if the directory exists and is writeable, false otherwise. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='dirCount'><!-- --></A><H3>dirCount</H3> <P><B>mixed dirCount ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Retrieves the number of subdirectories.</b> <pre> If called when the directory is not opened, it returns error object otherwise it returns number of subdirectories. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='open'><!-- --></A><H3>open</H3> <P><B>mixed open ( )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Opens the directory.</b> <pre> If called when the the directory is already opened, it returns error object otherwise it returns true. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='read'><!-- --></A><H3>read</H3> <P><B>mixed read ( [$asc = true] )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Read list of files and subdirectories.</b> <pre> If called when the directory is closed, it returns error object otherwise it returns array with file and direcotry objects contained in the directory. If the $asc param is omited the list is sorted in ascending order. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='readDirs'><!-- --></A><H3>readDirs</H3> <P><B>mixed readDirs ( [$asc = true] )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Read list of subdirectories.</b> <pre> If called when the directory is closed, it returns error object otherwise it returns array with direcotry objects contained in the directory. If the $asc param is omited the list is sorted in ascending order. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='readFiles'><!-- --></A><H3>readFiles</H3> <P><B>mixed readFiles ( [$asc = true] )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Read list of files.</b> <pre> If called when the directory is closed, it returns error object otherwise it returns array with file objects contained in the directory. If the $asc param is omited the list is sorted in ascending order. </pre> <DL> <DT>Function Parameters:</DT> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='remove'><!-- --></A><H3>remove</H3> <P><B>mixed remove ( $path )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Attempts to remove the subdirectory or file.</b> <pre> Returns true on success or error object with an error message on any kind of failure. </pre> <DL> <DT>Function Parameters:</DT> <DD><CODE>- <i>string $path</i>: the path to the subdirectory or file.</CODE></DD> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <A NAME='rename'><!-- --></A><H3>rename</H3> <P><B>mixed rename ( $path )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Attempts to rename the subdirectory or file.</b> <pre> Returns true on success or error object with an error message on any kind of failure. </pre> <DL> <DT>Function Parameters:</DT> <DD><CODE>- <i>string $path</i>: the path to the subdirectory or file.</CODE></DD> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> </DL> <HR> <hr> </HTML>