1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
5<meta http-equiv="Content-Style-Type" content="text/css" />
6<title>FSPathInfo</title>
7<link rel="stylesheet" href="../css/nitro.css" type="text/css" />
8</head>
9<body>
10
11<h1>FSPathInfo <img src="../image/NTR.gif"align="middle"><img src="../image/TWL.gif" align="middle"></h1>
12<h2>Definition</h2>
13<pre><code>
14
15#define FS_ATTRIBUTE_IS_DIRECTORY   0x00000100UL
16#define FS_ATTRIBUTE_IS_PROTECTED   0x00000200UL
17#define FS_ATTRIBUTE_IS_OFFLINE     0x00000400UL
18
19#define FS_ATTRIBUTE_DOS_MASK       0x000000FFUL
20#define FS_ATTRIBUTE_DOS_READONLY   0x00000001UL
21#define FS_ATTRIBUTE_DOS_HIDDEN     0x00000002UL
22#define FS_ATTRIBUTE_DOS_SYSTEM     0x00000004UL
23#define FS_ATTRIBUTE_DOS_VOLUME     0x00000008UL
24#define FS_ATTRIBUTE_DOS_DIRECTORY  0x00000010UL
25#define FS_ATTRIBUTE_DOS_ARCHIVE    0x00000020UL
26
27typedef struct FSPathInfo
28{
29    u32         attributes;
30    <a href="FSDateTime.html">FSDateTime</a>  ctime;
31    <a href="FSDateTime.html">FSDateTime</a>  mtime;
32    <a href="FSDateTime.html">FSDateTime</a>  atime;
33    u32         filesize;
34    u32         id;
35}
36FSPathInfo;
37
38</code></pre>
39
40<h2>Description</h2>
41<p>A structure that indicates the entry information that can be obtained with <code><a href="directory/FS_GetPathInfo.html">FS_GetPathInfo()</a></code>. The details of each member are as follows.</p>
42<table>
43<tr><td>attributes</td><td>The attributes of the entry. This is a combination of the attributes indicated by <CODE>FS_ATTRIBUTE_*</CODE>.
44<table style="background-color:white">
45<tr><td>FS_ATTRIBUTE_IS_DIRECTORY</td><td>This indicates that the entry is a directory.</td></tr>
46<tr><td>FS_ATTRIBUTE_IS_PROTECTED</td><td>This indicates that the entire archive that the entry belongs to is in a state in which writes are prohibited at a hardware level. This flag might be valid for <a href="archive_rom_spec.html">ROM archives</a> or <a href="archive_sdmc_spec.html">SD Card archives</a>, for example.</td></tr>
47<tr><td>FS_ATTRIBUTE_IS_OFFLINE</td><td>Indicates that the file referred to by the entry cannot be accessed in the current operating environment.<br />This flag is returned when a program running in the NITRO environment has referred to the information of a TWL-only file.<br />(For more information on the specification of TWL-only files, see the explanation about the <CODE>Put</CODE> parameter in <a href="../tools/makerom.html">makerom.TWL</a>.)</td></tr>
48<tr><td colspan="2">The attributes below are only valid for archives based on the FAT format.</td></tr>
49<tr><td>FS_ATTRIBUTE_DOS_READONLY</td><td>Indicates that the entry is read-only.</td></tr>
50<tr><td>FS_ATTRIBUTE_DOS_HIDDEN</td><td>This indicates that the entry is a hidden file.</td></tr>
51<tr><td>FS_ATTRIBUTE_DOS_SYSTEM</td><td>This indicates that the entry is a system file.</td></tr>
52<tr><td>FS_ATTRIBUTE_DOS_VOLUME</td><td>This indicates that the entry is a volume label.</td></tr>
53<tr><td>FS_ATTRIBUTE_DOS_DIRECTORY</td><td>This indicates that the entry is a directory. This is the same as FS_ATTRIBUTE_IS_DIRECTORY.</td></tr>
54<tr><td>FS_ATTRIBUTE_DOS_ARCHIVE</td><td>This indicates that the entry is an archive file.</td></tr>
55</table></td></tr>
56<tr><td>ctime</td><td>The creation date/time for an entry, expressed as an <a href="FSDateTime.html"><code>FSDateTime</code></a> type. If the date/time information is invalid, all members will be 0.</td></tr>
57<tr><td>mtime</td><td>The last date/time modified for an entry, expressed as an <a href="FSDateTime.html"><code>FSDateTime</code></a> type. If the date/time information is invalid, all members will be 0.</td></tr>
58<tr><td>atime</td><td>The last-accessed date/time for an entry, expressed as an <a href="FSDateTime.html"><code>FSDateTime</code></a> type. If the date/time information is invalid, all members will be 0.</td></tr>
59<tr><td>filesize</td><td>Size of the file. Only valid if the entry is a file.</td></tr>
60<tr><td>id</td><td>The ID of the file or directory. The value that is obtained can be used with functions such as <code><a href="file/FS_OpenFileFast.html">FS_OpenFileFast</a></code>. In cases where file IDs or directory IDs are not supported, such as with <a href="archive_nand_spec.html">NAND archives</a>, <code>FS_INVALID_FILE_ID</code> will always result.</td></tr>
61</table>
62
63<h2>See Also</h2>
64<p><code><a href="directory/FS_GetPathInfo.html">FS_GetPathInfo</a></code></p>
65
66<h2>Revision History</h2>
67<p>
682009/01/08 Added explanation about TWL-only files.<br />2008/12/08 Added the <CODE>FS_ATTRIBUTE_IS_OFFLINE</CODE> flag.<br />2008/06/13 Added the <CODE>FS_ATTRIBUTE_IS_PROTECTED</CODE> flag.<br />2007/12/13 Initial version.<br />
69</p>
70<hr><p>CONFIDENTIAL</p></body>
71</html>
72