diff options
| author | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
|---|---|---|
| committer | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
| commit | 0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch) | |
| tree | 2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/structNLMISC_1_1CFile.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/structNLMISC_1_1CFile.html | 762 |
1 files changed, 762 insertions, 0 deletions
diff --git a/docs/doxygen/nel/structNLMISC_1_1CFile.html b/docs/doxygen/nel/structNLMISC_1_1CFile.html new file mode 100644 index 00000000..abd5baf3 --- /dev/null +++ b/docs/doxygen/nel/structNLMISC_1_1CFile.html @@ -0,0 +1,762 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NLMISC::CFile Struct Reference</h1>Utility class for file manipulation. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="path_8h-source.html">path.h</a>></code> +<p> +<a href="structNLMISC_1_1CFile-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d0">getFilename</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Retrieve the associated file name.</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d1">getPath</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Retrieve the associated file path with the trailing slash.</em> <a href="#d1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d2">isDirectory</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Just to know if it is a directory.</em> <a href="#d2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d3">fileExists</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if the file exists.</em> <a href="#d3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d4">isExists</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if the file OR directory exists.</em> <a href="#d4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d5">findNewFile</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Return a new filename that doesn't exists.</em> <a href="#d5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d6">getLastSeparator</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Return the position between [begin,end[ of the last separator between path and filename ('/' or '\').</em> <a href="#d6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d7">getFilenameWithoutExtension</a> (const std::string &filename)</td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d8">getExtension</a> (const std::string &filename)</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d9">getFileSize</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Return the size of the file (in bytes).</em> <a href="#d9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d10">getFileModificationDate</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Return Time of last modification of file.</em> <a href="#d10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d11">getFileCreationDate</a> (const std::string &filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Return creation Time of the file.</em> <a href="#d11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d12">addFileChangeCallback</a> (const std::string &filename, void(*)(const std::string &filename))</td></tr> +<tr><td> </td><td><font size=-1><em>Add a callback that will be call when the content file, named filename, changed.</em> <a href="#d12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d13">checkFileChange</a> (<a class="el" href="namespaceNLMISC.html#a183">TTime</a> frequency=1000)</td></tr> +<tr><td> </td><td><font size=-1><em>You have to call this function evenly (each frame for example) to enable the file change callback system.</em> <a href="#d13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d14">copyFile</a> (const char *dest, const char *<a class="el" href="driver__opengl__extension__def_8h.html#a409">src</a>, bool failIfExists=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Copy a file NB this keeps file attributes.</em> <a href="#d14">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d15">moveFile</a> (const char *dest, const char *<a class="el" href="driver__opengl__extension__def_8h.html#a409">src</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Move a file NB this keeps file attributes.</em> <a href="#d15">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="structNLMISC_1_1CFile.html#d16">createDirectory</a> (const std::string &dirname)</td></tr> +<tr><td> </td><td><font size=-1><em>create a directory.</em> <a href="#d16">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Utility class for file manipulation. +<p> +<dl compact><dt><b> +Author: </b><dd> +Vianney Lecroart , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="path_8h-source.html#l00215">215</a> of file <a class="el" href="path_8h-source.html">path.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="d12" doxytag="NLMISC::CFile::addFileChangeCallback"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLMISC::CFile::addFileChangeCallback </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname" nowrap> <em>filename</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void(* </td> + <td class="mdname" nowrap> )(const std::string &filename)</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Add a callback that will be call when the content file, named filename, changed. +<p> +The system use the file modification date. To work, you need to call evenly the function <a class="el" href="structNLMISC_1_1CFile.html#d13">checkFileChange</a>(), this function only checks every 1s by default (you can change the default time) +<p> +ie: void cb (const std::string &filename) { nlinfo ("the file s changed", filename.c_str()); } <a class="el" href="structNLMISC_1_1CFile.html#d12">CFile::addFileChangeCallback</a> ("myfile.txt", cb); +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01149">1149</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +References <a class="el" href="path_8cpp-source.html#l01146">NLMISC::FileToCheck</a>, and <a class="el" href="debug_8h-source.html#l00094">nlinfo</a>. </td> + </tr> +</table> +<a name="d13" doxytag="NLMISC::CFile::checkFileChange"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLMISC::CFile::checkFileChange </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLMISC.html#a183">TTime</a> </td> + <td class="mdname1" valign="top" nowrap> <em>frequency</em> = 1000 </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +You have to call this function evenly (each frame for example) to enable the file change callback system. +<p> +If the file not exists and is created in the run time, the callback will be called. If the file exists and is removed in the run time, the callback will be called.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>frequency</em> </td><td> +the time in millisecond that we wait before check another time (1s by default). </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01155">1155</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +References <a class="el" href="path_8cpp-source.html#l01146">NLMISC::FileToCheck</a>, and <a class="el" href="time__nl_8h-source.html#l00047">NLMISC::TTime</a>. </td> + </tr> +</table> +<a name="d14" doxytag="NLMISC::CFile::copyFile"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLMISC::CFile::copyFile </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>dest</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>src</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>failIfExists</em> = false</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Copy a file NB this keeps file attributes. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>failIfExists</em> </td><td> +If the destination file exists, nothing is done, and it returns false. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +true if the copy succeeded </dl> +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01194">1194</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +References <a class="el" href="path_8cpp-source.html#l01178">NLMISC::CopyMoveFile</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00820">src</a>. </td> + </tr> +</table> +<a name="d16" doxytag="NLMISC::CFile::createDirectory"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLMISC::CFile::createDirectory </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>dirname</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +create a directory. +<p> +<dl compact><dt><b> +Returns: </b><dd> +true if succes </dl> +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01205">1205</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. </td> + </tr> +</table> +<a name="d3" doxytag="NLMISC::CFile::fileExists"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLMISC::CFile::fileExists </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return true if the file exists. +<p> +Warning: this test will also tell that the file does not exist if you don't have the rights to read it (Unix). +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01024">1024</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. </td> + </tr> +</table> +<a name="d5" doxytag="NLMISC::CFile::findNewFile"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> string NLMISC::CFile::findNewFile </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a new filename that doesn't exists. +<p> +It's used for screenshot filename for example. example: findNewFile("foobar.tga"); will try foobar001.tga, if the file exists, try foobar002.tga and so on until it finds an unexistant file. +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01030">1030</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +References <a class="el" href="driver__opengl__extension__def_8h-source.html#l00820">num</a>, and <a class="el" href="common_8cpp-source.html#l00153">NLMISC::smprintf</a>. </td> + </tr> +</table> +<a name="d8" doxytag="NLMISC::CFile::getExtension"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> string NLMISC::CFile::getExtension </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l00974">974</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +Referenced by <a class="el" href="animation__set_8cpp-source.html#l00155">NL3D::CAnimationSet::loadFromFiles</a>. </td> + </tr> +</table> +<a name="d11" doxytag="NLMISC::CFile::getFileCreationDate"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a11">uint32</a> NLMISC::CFile::getFileCreationDate </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return creation Time of the file. +<p> +0 if not found. +<p> +You have to provide the full path of the file (the function doesn't lookup) +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01110">1110</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. </td> + </tr> +</table> +<a name="d10" doxytag="NLMISC::CFile::getFileModificationDate"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a11">uint32</a> NLMISC::CFile::getFileModificationDate </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return Time of last modification of file. +<p> +0 if not found. +<p> +You have to provide the full path of the file (the function doesn't lookup) +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01084">1084</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +Referenced by <a class="el" href="load__form_8h-source.html#l00113">loadForm</a>. </td> + </tr> +</table> +<a name="d0" doxytag="NLMISC::CFile::getFilename"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> string NLMISC::CFile::getFilename </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Retrieve the associated file name. +<p> +An empty string is returned if the path is invalid +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l00955">955</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +Referenced by <a class="el" href="path_8cpp-source.html#l00964">getFilenameWithoutExtension</a>. </td> + </tr> +</table> +<a name="d7" doxytag="NLMISC::CFile::getFilenameWithoutExtension"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> string NLMISC::CFile::getFilenameWithoutExtension </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l00964">964</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +References <a class="el" href="path_8cpp-source.html#l00955">getFilename</a>. +<p> +Referenced by <a class="el" href="animation__set_8cpp-source.html#l00155">NL3D::CAnimationSet::loadFromFiles</a>. </td> + </tr> +</table> +<a name="d9" doxytag="NLMISC::CFile::getFileSize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a11">uint32</a> NLMISC::CFile::getFileSize </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the size of the file (in bytes). +<p> +You have to provide the full path of the file (the function doesn't lookup) +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01055">1055</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. </td> + </tr> +</table> +<a name="d6" doxytag="NLMISC::CFile::getLastSeparator"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> int NLMISC::CFile::getLastSeparator </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the position between [begin,end[ of the last separator between path and filename ('/' or '\'). +<p> +If there's no separator, it returns string::npos. +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l00941">941</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. </td> + </tr> +</table> +<a name="d1" doxytag="NLMISC::CFile::getPath"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> string NLMISC::CFile::getPath </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Retrieve the associated file path with the trailing slash. +<p> +Returns an empty string if the path is invalid +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l00983">983</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. </td> + </tr> +</table> +<a name="d2" doxytag="NLMISC::CFile::isDirectory"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLMISC::CFile::isDirectory </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Just to know if it is a directory. +<p> +_FileName empty and path not !!! +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l00992">992</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +References <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00815">res</a>. </td> + </tr> +</table> +<a name="d4" doxytag="NLMISC::CFile::isExists"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLMISC::CFile::isExists </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return true if the file OR directory exists. +<p> +Warning: this test will also tell that the file does not exist if you don't have the rights to read it (Unix). +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01014">1014</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. </td> + </tr> +</table> +<a name="d15" doxytag="NLMISC::CFile::moveFile"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLMISC::CFile::moveFile </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>dest</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>src</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Move a file NB this keeps file attributes. +<p> + +<p> +Definition at line <a class="el" href="path_8cpp-source.html#l01199">1199</a> of file <a class="el" href="path_8cpp-source.html">path.cpp</a>. +<p> +References <a class="el" href="path_8cpp-source.html#l01178">NLMISC::CopyMoveFile</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00820">src</a>. </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following files:<ul> +<li><a class="el" href="path_8h-source.html">path.h</a><li><a class="el" href="path_8cpp-source.html">path.cpp</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |