📄 file_8h.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>BlueLab: file.h File Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.8 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>file.h File Reference</h1>Access to the read-only file-system. <a href="#_details">More...</a><p><h2>Functions</h2><ul><li><a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> <a class="el" href="file_8h.html#a0">FileFind</a> (<a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> start, const char *name, <a class="el" href="csrtypes_8h.html#a4">uint16</a> length)<dl class="el"><dd class="mdescRight">Find the index for a named file or directory, relative to the starting directory. <a href="#a0"></a><br></dl><li><a class="el" href="file__if_8h.html#a7">FILE_TYPE</a> <a class="el" href="file_8h.html#a1">FileType</a> (<a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> index)<dl class="el"><dd class="mdescRight">Find the type of a file specified by its index. <a href="#a1"></a><br></dl><li><a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> <a class="el" href="file_8h.html#a2">FileParent</a> (<a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> item)<dl class="el"><dd class="mdescRight">Find the index of the directory containg this file or directory. <a href="#a2"></a><br></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>Access to the read-only file-system. <p><hr><h2>Function Documentation</h2><a class="anchor" name="a0" doxytag="file.h::FileFind" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> FileFind </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> </td> <td class="mdname" nowrap> <em>start</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>name</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname" nowrap> <em>length</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Find the index for a named file or directory, relative to the starting directory. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>start</em> </td><td>index of directory in which to start the search </td></tr> <tr><td></td><td valign=top><em>name</em> </td><td>the name (possibly including a path) of the item to find </td></tr> <tr><td></td><td valign=top><em>length</em> </td><td>the number of characters in <em>name</em> </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>the index of the item searched for, or <a class="el" href="file__if_8h.html#a0">FILE_NONE</a> if no such item exists.</dd></dl>Leading and trailing directory separators in <em>name</em> are ignored.<p><em>start</em> is commonly <a class="el" href="file__if_8h.html#a1">FILE_ROOT</a>. </td> </tr></table><a class="anchor" name="a1" doxytag="file.h::FileType" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="file__if_8h.html#a7">FILE_TYPE</a> FileType </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> </td> <td class="mdname1" valign="top" nowrap> <em>index</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Find the type of a file specified by its index. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>index</em> </td><td>the index of the file whose type is required</td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>the type of the specified file </dd></dl> </td> </tr></table><a class="anchor" name="a2" doxytag="file.h::FileParent" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> FileParent </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="file__if_8h.html#a2">FILE_INDEX</a> </td> <td class="mdname1" valign="top" nowrap> <em>item</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Find the index of the directory containg this file or directory. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>item</em> </td><td>The index of the item we know about.</td></tr> </table></dl>Returns the index of the directory containing item, or FILE_NONE. </td> </tr></table></body></html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -