1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<HTML> 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<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows"> 7<BASE target="main"> 8<TITLE>ROM File System (FS) Function List</TITLE> 9<LINK rel="stylesheet" href="../css/apilist.css"> 10</HEAD> 11<BODY> 12<H1>ROM File System (FS) Function List</H1> 13<H3><A name="Init">Initialization</A></H3> 14<TABLE border="1" width="100%"> 15 <TBODY> 16 <TR> 17<TH width="25%"><A href="file/FS_Init.html" target="_self">FS_Init</A></TH> 18 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 19<TD>Initializes the ROM file system.</TD> 20 </TR> 21 <TR> 22<TH width="25%"><A href="archive/FS_InitFatDriver.html" target="_self">FS_InitFatDriver</A></TH> 23 <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 24<TD>Initializes the FAT Library.</TD> 25 </TR> 26 <TR> 27<TH width="25%"><A href="file/FS_IsAvailable.html" target="_self">FS_IsAvailable</A></TH> 28 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 29<TD>Determines whether the ROM file system has been initialized.</TD> 30 </TR> 31 <TR> 32<TH width="25%"><A href="file/FS_End.html" target="_self">FS_End</A></TH> 33 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 34<TD>Closes the ROM file system.</TD> 35 </TR> 36 <TR> 37<TH width="25%"><A href="file/FS_SetDefaultDMA.html" target="_self">FS_SetDefaultDMA</A></TH> 38 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 39<TD>Sets the DMA number to use.</TD> 40 </TR> 41 <TR> 42<TH width="25%"><A href="file/FS_SetCurrentDirectory.html" target="_self">FS_SetCurrentDirectory</A></TH> 43 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 44<TD>Sets the current directory.</TD> 45 </TR> 46 <TR> 47<TH width="25%"><A href="file/FS_ForceToEnableLatencyEmulation.html" target="_self">FS_ForceToEnableLatencyEmulation</A></TH> 48 <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 49<TD>Emulates the behavior of NAND memory and SD Card devices when performance has deteriorated.</TD> 50 </TR> 51 <TR> 52<TH width="25%"><A href="file/FS_LoadTable.html" target="_self">FS_LoadTable</A></TH> 53 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 54<TD>Loads tables into memory that are frequently accessed internally.</TD> 55 </TR> 56 <TR> 57<TH width="25%"><A href="file/FS_UnloadTable.html" target="_self">FS_UnloadTable</A></TH> 58 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 59<TD>Releases the memory that was used for loading the table.</TD> 60 </TR> 61 <TR> 62<TH width="25%"><A href="file/FS_GetTableSize.html" target="_self">FS_GetTableSize</A></TH> 63 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 64<TD>Gets the memory size that is required for internal tables.</TD> 65 </TR> 66 <TR> 67<TH width="25%"><A href="archive_rom_spec.html" target="_self">ROM Archive</A></TH> 68 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 69<TD rowspan="4">Archives that are loaded into the file system by default.</TD> 70 </TR> 71 <TR> 72<TH width="25%"><A href="archive_mem_spec.html" target="_self">Memory File Archive</A></TH> 73 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 74 </TR> 75 <TR> 76<TH width="25%"><A href="archive_nand_spec.html" target="_self">NAND Archive</A></TH> 77 <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 78 </TR> 79 <TR> 80<TH width="25%"><A href="archive_sdmc_spec.html" target="_self">SD Card Archive</A></TH> 81 <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 82 </TR> 83 </TBODY> 84</TABLE> 85<H3><A name="Handle">Handle Information</A></H3> 86<TABLE border="1" width="100%"> 87 <TBODY> 88 <TR> 89<TH width="25%"><A href="file/FS_InitFile.html" target="_self">FS_InitFile</A></TH> 90 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 91<TD>Initializes the <CODE>FSFile</CODE> structure.</TD> 92 </TR> 93 <TR> 94<TH width="25%"><A href="file/FS_IsBusy.html" target="_self">FS_IsBusy</A></TH> 95 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 96<TD>Determines whether the specified file is currently busy with an asynchronous process.</TD> 97 </TR> 98 <TR> 99<TH width="25%"><A href="file/FS_IsSucceeded.html" target="_self">FS_IsSucceeded</A></TH> 100 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 101<TD>Determines whether the specified file's last asynchronous process succeeded.</TD> 102 </TR> 103 <TR> 104<TH width="25%"><A href="file/FS_IsFile.html" target="_self">FS_IsFile</A></TH> 105 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 106<TD>Determines whether file information is currently stored in the specified file.</TD> 107 </TR> 108 <TR> 109<TH width="25%"><A href="file/FS_IsDir.html" target="_self">FS_IsDir</A></TH> 110 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 111<TD>Determines whether the directory position is currently stored in the specified file.</TD> 112 </TR> 113 <TR> 114<TH width="25%"><A href="file/FS_GetAttachedArchive.html" target="_self">FS_GetAttachedArchive</A></TH> 115 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 116<TD>Gets the archive associated with the file.</TD> 117 </TR> 118 <TR> 119<TH width="25%"><A href="file/FS_GetResultCode.html" target="_self">FS_GetResultCode</A></TH> 120 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 121<TD>Gets the result value of the last process done in the specified file.</TD> 122 </TR> 123 <TR> 124<TH width="25%"><A href="archive/FS_GetArchiveResultCode.html" target="_self">FS_GetArchiveResultCode</A></TH> 125 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 126<TD>Gets the result value of the last process done in the specified archive.</TD> 127 </TR> 128 <TR> 129<TH width="25%"><A href="file/FS_WaitAsync.html" target="_self">FS_WaitAsync</A></TH> 130 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 131<TD>Waits for an asynchronous process that a file is executing to complete.</TD> 132 </TR> 133 <TR> 134<TH width="25%"><A href="file/FS_CancelFile.html" target="_self">FS_CancelFile</A></TH> 135 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 136<TD>Cancels the asynchronous process the file is currently executing.</TD> 137 </TR> 138 <TR> 139<TH width="25%"><A href="file/FS_GetPathName.html" target="_self">FS_GetPathName</A></TH> 140 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 141<TD>Gets the path of an open file or directory.</TD> 142 </TR> 143 <TR> 144<TH width="25%"><A href="file/FS_GetPathLength.html" target="_self">FS_GetPathLength</A></TH> 145 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 146<TD>Gets the length of the path of an open file or directory.</TD> 147 </TR> 148 </TBODY> 149</TABLE> 150 151<H3><A name="File">File Access</A></H3> 152<TABLE border="1" width="100%"> 153 <TBODY> 154 <TR> 155<TH width="25%"><A href="file/FS_OpenFileEx.html" target="_self">FS_OpenFileEx[W]</A></TH> 156 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 157<TD>Opens a file by specifying a path.</TD> 158 </TR> 159 <TR> 160<TH width="25%"><A href="file/FS_CloseFile.html" target="_self">FS_CloseFile</A></TH> 161 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 162<TD>Closes a file.</TD> 163 </TR> 164 <TR> 165<TH width="25%"><A href="file/FS_OpenFileFast.html" target="_self">FS_OpenFileFast</A></TH> 166 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 167<TD>Opens a file by specifying an ID.</TD> 168 </TR> 169 <TR> 170<TH width="25%"><A href="file/FS_ConvertPathToFileID.html" target="_self">FS_ConvertPathToFileID</A></TH> 171 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 172<TD>Gets a file ID from a specified path.</TD> 173 </TR> 174 <TR> 175<TH width="25%"><A href="file/FS_OpenFileDirect.html" target="_self">FS_OpenFileDirect</A></TH> 176 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 177<TD>Opens a file by specifying a region.</TD> 178 </TR> 179 <TR> 180<TH width="25%"><A href="file/FS_GetFileImageTop.html" target="_self">FS_GetFileImageTop</A></TH> 181 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 182<TD>Gets the offset value at the beginning of the region in an open file.</TD> 183 </TR> 184 <TR> 185<TH width="25%"><A href="file/FS_GetFileImageBottom.html" target="_self">FS_GetFileImageBottom</A></TH> 186 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 187<TD>Gets the offset value at the end of the region in an open file.</TD> 188 </TR> 189 <TR> 190<TH width="25%"><A href="file/FS_GetFileLength.html" target="_self">FS_GetFileLength</A></TH> 191 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 192<TD>Gets the size of an open file.</TD> 193 </TR> 194 <TR> 195<TH width="25%"><A href="file/FS_SetFileLength.html" target="_self">FS_SetFileLength</A></TH> 196 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 197<TD>Changes the size of an open file.</TD> 198 </TR> 199 <TR> 200<TH width="25%"><A href="file/FS_GetFilePosition.html" target="_self">FS_GetFilePosition</A></TH> 201 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 202<TD>Gets the current position of an open file.</TD> 203 </TR> 204 <TR> 205<TH width="25%"><A href="file/FS_GetSeekCacheSize.html" target="_self">FS_GetSeekCacheSize</A></TH> 206 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 207<TD>Calculates the size of the seek cache buffer.</TD> 208 </TR> 209 <TR> 210<TH width="25%"><A href="file/FS_SetSeekCache.html" target="_self">FS_SetSeekCache</A></TH> 211 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 212<TD>Sets the seek cache buffer for an open file.</TD> 213 </TR> 214 <TR> 215<TH width="25%"><A href="file/FS_SeekFile.html" target="_self">FS_SeekFile</A></TH> 216 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 217<TD>Moves the position of an open file pointer.</TD> 218 </TR> 219 <TR> 220<TH width="25%"><A href="file/FS_SeekFileToBegin.html" target="_self">FS_SeekFileToBegin</A></TH> 221 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 222<TD>Moves the position of an open file pointer to the beginning.</TD> 223 </TR> 224 <TR> 225<TH width="25%"><A href="file/FS_SeekFileToEnd.html" target="_self">FS_SeekFileToEnd</A></TH> 226 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 227<TD>Moves the position of an open file pointer to the end.</TD> 228 </TR> 229 <TR> 230<TH width="25%"><A href="file/FS_ReadFile.html" target="_self">FS_ReadFile</A></TH> 231 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 232<TD>Reads data from an open file.</TD> 233 </TR> 234 <TR> 235<TH width="25%"><A href="file/FS_ReadFileAsync.html" target="_self">FS_ReadFileAsync</A></TH> 236 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 237<TD>Reads data from an open file in asynchronous mode.</TD> 238 </TR> 239 <TR> 240<TH width="25%"><A href="file/FS_WriteFile.html" target="_self">FS_WriteFile</A></TH> 241 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 242<TD>Writes data to an open file.</TD> 243 </TR> 244 <TR> 245<TH width="25%"><A href="file/FS_WriteFileAsync.html" target="_self">FS_WriteFileAsync</A></TH> 246 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 247<TD>Asynchronously writes data to an open file.</TD> 248 </TR> 249 <TR> 250<TH width="25%"><A href="file/FS_FlushFile.html" target="_self">FS_FlushFile</A></TH> 251 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 252<TD>Makes a request to reliably write back changes to an open file to the device.</TD> 253 </TR> 254 <TR> 255<TH width="25%"><A href="file/FS_CreateFileFromMemory.html" target="_self">FS_CreateFileFromMemory</A></TH> 256 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 257<TD>Treats the specified memory region as a temporary file and opens it.</TD> 258 </TR> 259 <TR> 260<TH width="25%"><A href="file/FS_CreateFileFromRom.html" target="_self">FS_CreateFileFromRom</A></TH> 261 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 262<TD>Treats the specified CARD-ROM region as a temporary file and opens it.</TD> 263 </TR> 264 </TBODY> 265</TABLE> 266<H3><A name="Directory">Directory Access</A></H3> 267<TABLE border="1" width="100%"> 268 <TBODY> 269 <TR> 270<TH width="25%"><A href="directory/FS_GetPathInfo.html" target="_self">FS_GetPathInfo</A></TH> 271 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 272<TD>Gets the file or directory information.</TD> 273 </TR> 274 <TR> 275<TH width="25%"><A href="directory/FS_SetPathInfo.html" target="_self">FS_SetPathInfo</A></TH> 276 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 277<TD>Changes the file or directory information.</TD> 278 </TR> 279 <TR> 280<TH width="25%"><A href="directory/FS_CreateFile.html" target="_self">FS_CreateFile</A></TH> 281 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 282<TD>Creates a file.</TD> 283 </TR> 284 <TR> 285<TH width="25%"><A href="directory/FS_DeleteFile.html" target="_self">FS_DeleteFile</A></TH> 286 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 287<TD>Deletes a file.</TD> 288 </TR> 289 <TR> 290<TH width="25%"><A href="directory/FS_RenameFile.html" target="_self">FS_RenameFile</A></TH> 291 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 292<TD>Changes a file name.</TD> 293 </TR> 294 <TR> 295<TH width="25%"><A href="directory/FS_CreateDirectory.html" target="_self">FS_CreateDirectory</A></TH> 296 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 297<TD>Creates a directory.</TD> 298 </TR> 299 <TR> 300<TH width="25%"><A href="directory/FS_DeleteDirectory.html" target="_self">FS_DeleteDirectory</A></TH> 301 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 302<TD>Deletes a directory.</TD> 303 </TR> 304 <TR> 305<TH width="25%"><A href="directory/FS_RenameDirectory.html" target="_self">FS_RenameDirectory</A></TH> 306 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 307<TD>Changes a directory name.</TD> 308 </TR> 309 310 <TR> 311<TH width="25%"><A href="directory/FS_XXXAuto.html" target="_self">FS_CreateFileAuto</A></TH> 312 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 313<TD>Creates a file. Automatically creates any intermediate directories as necessary.</TD> 314 </TR> 315 <TR> 316<TH width="25%"><A href="directory/FS_XXXAuto.html" target="_self">FS_DeleteFileAuto</A></TH> 317 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 318<TD>Deletes a file. (The actual operation is the same as that of the <CODE>FS_DeleteFile</CODE> function, but this is provided for the sake of consistency.) </TD> 319 </TR> 320 <TR> 321<TH width="25%"><A href="directory/FS_XXXAuto.html" target="_self">FS_RenameFileAuto</A></TH> 322 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 323<TD>Changes a file name. Automatically creates intermediate directories as necessary.</TD> 324 </TR> 325 <TR> 326<TH width="25%"><A href="directory/FS_XXXAuto.html" target="_self">FS_CreateDirectoryAuto</A></TH> 327 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 328<TD>Creates a directory. Automatically creates intermediate directories as necessary.</TD> 329 </TR> 330 <TR> 331<TH width="25%"><A href="directory/FS_XXXAuto.html" target="_self">FS_DeleteDirectoryAuto</A></TH> 332 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 333<TD>Deletes a directory. Also deletes all subdirectories as necessary.</TD> 334 </TR> 335 <TR> 336<TH width="25%"><A href="directory/FS_XXXAuto.html" target="_self">FS_RenameDirectoryAuto</A></TH> 337 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 338<TD>Changes a directory name. Automatically creates intermediate directories as necessary.</TD> 339 </TR> 340 <TR> 341<TH width="25%"><A href="directory/FS_OpenTopLevelDirectory.html" target="_self">FS_OpenTopLevelDirectory</A></TH> 342 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 343<TD>Opens the top-level directory that lists the archive names.</TD> 344 </TR> 345 <TR> 346<TH width="25%"><A href="directory/FS_OpenDirectory.html" target="_self">FS_OpenDirectory[W]</A></TH> 347 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 348<TD>Opens a directory by specifying a path.</TD> 349 </TR> 350 <TR> 351<TH width="25%"><A href="directory/FS_CloseDirectory.html" target="_self">FS_CloseDirectory</A></TH> 352 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 353<TD>Closes a directory.</TD> 354 </TR> 355 <TR> 356<TH width="25%"><A href="directory/FS_ReadDirectory.html" target="_self">FS_ReadDirectory[W]</A></TH> 357 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 358<TD>Reads entry information from a directory handle.</TD> 359 </TR> 360 <TR> 361<TH width="25%"><A href="file/FS_TellDir.html" target="_self">FS_TellDir</A></TH> 362 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 363<TD>Gets the current position in a directory list.</TD> 364 </TR> 365 <TR> 366<TH width="25%"><A href="file/FS_SeekDir.html" target="_self">FS_SeekDir</A></TH> 367 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 368<TD>Sets the current position in a directory list.</TD> 369 </TR> 370 <TR> 371<TH width="25%"><A href="file/FS_RewindDir.html" target="_self">FS_RewindDir</A></TH> 372 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 373<TD>Returns the current position in a directory list to the beginning.</TD> 374 </TR> 375 </TBODY> 376</TABLE> 377<H3><A name="Archive">Archives</A></H3> 378<TABLE border="1"> 379 <TBODY> 380 <TR> 381<TD width="25%"><A href="archive/FS_InitArchive.html" target="_self">FS_InitArchive</A></TD> 382 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 383<TD>Initializes the archive structure.</TD> 384 </TR> 385 <TR> 386<TD width="25%"><A href="archive/FS_GetArchiveName.html" target="_self">FS_GetArchiveName</A></TD> 387 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 388<TD>Gets the name of the archive.</TD> 389 </TR> 390 <TR> 391<TD width="25%"><A href="archive/FS_GetArchiveResource.html" target="_self">FS_GetArchiveResource</A></TD> 392 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 393<TD>Gets the resource information of an archive.</TD> 394 </TR> 395 <TR> 396<TD width="25%"><A href="archive/FS_HasEnoughSpaceToCreateFile.html" target="_self">FS_HasEnoughSpaceToCreateFile</A></TD> 397 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 398<TD>Determines whether a file with the specified path and size can actually be created.</TD> 399 </TR> 400 <TR> 401<TD width="25%"><A href="archive/FS_IsArchiveReady.html" target="_self">FS_IsArchiveReady</A></TD> 402 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 403<TD>Determines whether the specified archive is available for use.</TD> 404 </TR> 405 <TR> 406<TD width="25%"><A href="archive/FS_GetArchiveBase.html" target="_self">FS_GetArchiveBase</A></TD> 407 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 408<TD>Gets the base offset of the archive.</TD> 409 </TR> 410 <TR> 411<TD width="25%"><A href="archive/FS_GetArchiveFAT.html" target="_self">FS_GetArchiveFAT</A></TD> 412 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 413<TD>Gets the FAT offset of the archive.</TD> 414 </TR> 415 <TR> 416<TD width="25%"><A href="archive/FS_GetArchiveFNT.html" target="_self">FS_GetArchiveFNT</A></TD> 417 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 418<TD>Gets the FNT offset of the archive.</TD> 419 </TR> 420 <TR> 421<TD width="25%"><A href="archive/FS_GetArchiveOffset.html" target="_self">FS_GetArchiveOffset</A></TD> 422 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 423<TD>Gets a specified location offset from the base of the archive.</TD> 424 </TR> 425 <TR> 426<TD width="25%"><A href="archive/FS_IsArchiveLoaded.html" target="_self">FS_IsArchiveLoaded</A></TD> 427 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 428<TD>Determines if the archive has been loaded into the current file system.</TD> 429 </TR> 430 <TR> 431<TD width="25%"><A href="archive/FS_IsArchiveTableLoaded.html" target="_self">FS_IsArchiveTableLoaded</A></TD> 432 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 433<TD>Determines if the current table has been preloaded in the archive.</TD> 434 </TR> 435 <TR> 436<TD width="25%"><A href="archive/FS_IsArchiveSuspended.html" target="_self">FS_IsArchiveSuspended</A></TD> 437 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 438<TD>Determines if the archive is currently being suspended.</TD> 439 </TR> 440 <TR> 441<TD width="25%"><A href="archive/FS_FindArchive.html" target="_self">FS_FindArchive</A></TD> 442 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 443<TD>Searches for the archive with the specified name.</TD> 444 </TR> 445 <TR> 446<TD width="25%"><A href="archive/FS_RegisterArchiveName.html" target="_self">FS_RegisterArchiveName</A></TD> 447 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 448<TD>Registers an archive name and associates it with the archive.</TD> 449 </TR> 450 <TR> 451<TD width="25%"><A href="archive/FS_ReleaseArchiveName.html" target="_self">FS_ReleaseArchiveName</A></TD> 452 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 453<TD>Releases the registered archive.</TD> 454 </TR> 455 <TR> 456<TD width="25%"><A href="archive/FS_LoadArchive.html" target="_self">FS_LoadArchive</A></TD> 457 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 458<TD>Loads an archive into the file system.</TD> 459 </TR> 460 <TR> 461<TD width="25%"><A href="archive/FS_UnloadArchive.html" target="_self">FS_UnloadArchive</A></TD> 462 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 463<TD>Unloads an archive from the file system.</TD> 464 </TR> 465 <TR> 466<TD width="25%"><A href="archive/FS_LoadArchiveTables.html" target="_self">FS_LoadArchiveTables</A></TD> 467 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 468<TD>Preloads both the FNT and the FAT to achieve greater efficiency.</TD> 469 </TR> 470 <TR> 471<TD width="25%"><A href="archive/FS_UnloadArchiveTables.html" target="_self">FS_UnloadArchiveTables</A></TD> 472 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 473<TD>Clears the FNT and FAT from the preloaded memory.</TD> 474 </TR> 475 <TR> 476<TD width="25%"><A href="archive/FS_SuspendArchive.html" target="_self">FS_SuspendArchive</A></TD> 477 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 478<TD>Stops the processing of the archive.</TD> 479 </TR> 480 <TR> 481<TD width="25%"><A href="archive/FS_ResumeArchive.html" target="_self">FS_ResumeArchive</A></TD> 482 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 483<TD>Restarts processing of the archive (after it's been intentionally stopped).</TD> 484 </TR> 485 <TR> 486<TD width="25%"><A href="archive/FS_SetArchiveProc.html" target="_self">FS_SetArchiveProc</A></TD> 487 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 488<TD>Sets the user procedure of the archive.</TD> 489 </TR> 490 <TR> 491<TD width="25%"><A href="archive/FS_NotifyArchiveAsyncEnd.html" target="_self">FS_NotifyArchiveAsyncEnd</A></TD> 492 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 493<TD>Sends notification that the asynchronous processing performed by the archive is complete.</TD> 494 </TR> 495 <TR> 496<TD width="25%"><A href="archive/FS_RegisterEventHook.html" target="_self">FS_RegisterEventHook</A></TD> 497 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 498<TD>Registers hooks to monitor archive events.</TD> 499 </TR> 500 <TR> 501<TD width="25%"><A href="archive/FS_UnregisterEventHook.html" target="_self">FS_UnregisterEventHook</A></TD> 502 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 503<TD>Unregisters hooks that monitor archive events.</TD> 504 </TR> 505 </TBODY> 506</TABLE> 507<H3><A name="Overlay">Overlay</A></H3> 508<TABLE border="1" width="100%"> 509 <TBODY> 510 <TR> 511<TH width="25%"><A href="overlay/FS_AttachOverlayTable.html" target="_self">FS_AttachOverlayTable</A></TH> 512 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 513<TD>Sets the overlay table.</TD> 514 </TR> 515 <TR> 516<TH width="25%"><A href="overlay/FS_LoadOverlayInfo.html" target="_self">FS_LoadOverlayInfo</A></TH> 517 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 518<TD>Loads the overlay module information.</TD> 519 </TR> 520 <TR> 521<TH width="25%"><A href="overlay/FS_GetOverlayTotalSize.html" target="_self">FS_GetOverlayTotalSize</A></TH> 522 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 523<TD>Obtains the total size of the overlay module.</TD> 524 </TR> 525 <TR> 526<TH width="25%"><A href="overlay/FS_GetOverlayImageSize.html" target="_self">FS_GetOverlayImageSize</A></TH> 527 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 528<TD>Obtains the load image size of the overlay module.</TD> 529 </TR> 530 <TR> 531<TH width="25%"><A href="overlay/FS_GetOverlayAddress.html" target="_self">FS_GetOverlayAddress</A></TH> 532 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 533<TD>Obtains the starting address of the overlay module.</TD> 534 </TR> 535 <TR> 536<TH width="25%"><A href="overlay/FS_GetOverlayFileID.html" target="_self">FS_GetOverlayFileID</A></TH> 537 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 538<TD>Obtains the file ID that stores the load image of the overlay module.</TD> 539 </TR> 540 <TR> 541<TH width="25%"><A href="overlay/FS_ClearOverlayImage.html" target="_self">FS_ClearOverlayImage</A></TH> 542 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 543<TD>Clears the overlay module region.</TD> 544 </TR> 545 <TR> 546<TH width="25%"><A href="overlay/FS_LoadOverlayImage.html" target="_self">FS_LoadOverlayImage</A></TH> 547 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 548<TD>Loads the overlay module image to memory.</TD> 549 </TR> 550 <TR> 551<TH width="25%"><A href="overlay/FS_LoadOverlayImageAsync.html" target="_self">FS_LoadOverlayImageAsync</A></TH> 552 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 553<TD>Asynchronously loads the overlay module image to memory.</TD> 554 </TR> 555 <TR> 556<TH width="25%"><A href="overlay/FS_StartOverlay.html" target="_self">FS_StartOverlay</A></TH> 557 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 558<TD>Executes the overlay module image initialization process.</TD> 559 </TR> 560 <TR> 561<TH width="25%"><A href="overlay/FS_EndOverlay.html" target="_self">FS_EndOverlay</A></TH> 562 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 563<TD>Executes the overlay module image termination process.</TD> 564 </TR> 565 <TR> 566<TH width="25%"><A href="overlay/FS_UnloadOverlayImage.html" target="_self">FS_UnloadOverlayImage</A></TH> 567 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 568<TD>Unloads the overlay module image from the memory.</TD> 569 </TR> 570 571 <TR> 572<TH width="25%"><A href="overlay/FS_LoadOverlay.html" target="_self">FS_LoadOverlay</A></TH> 573 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 574<TD>Loads the overlay module and executes the initialization process.</TD> 575 </TR> 576 <TR> 577<TH width="25%"><A href="overlay/FS_UnloadOverlay.html" target="_self">FS_UnloadOverlay</A></TH> 578 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 579<TD>Unloads an overlay module.</TD> 580 </TR> 581 </TBODY> 582</TABLE> 583<H3><A name="const">Constants</A></H3> 584<TABLE border="1" width="100%"> 585 <TBODY> 586 <TR> 587<TH><A href="fs_result_const.html" target="_self">FSResult</A></TH> 588 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 589<TD>Expresses the result of the archive command.</TD> 590 </TR> 591 <TR> 592<TH width="25%"><A href="fs_seek_file_mode_type.html" target="_self">FSSeekFileMode</A></TH> 593 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 594<TD>Expresses the base position when moving a file pointer.</TD> 595 </TR> 596 <TR> 597<TH width="25%"><A href="fs_file_name_max_const.html" target="_self">FS_FILE_NAME_MAX</A></TH> 598 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 599<TD>The maximum number of characters that can be in a path.</TD> 600 </TR> 601 <TR> 602<TH width="25%"><A href="fs_archive_name_len_max_const.html" target="_self">FS_ARCHIVE_NAME_LEN_MAX</A></TH> 603 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 604<TD>The maximum number of characters for archive names.</TD> 605 </TR> 606 <TR> 607<TH width="25%"><A href="fs_dma_not_use_const.html" target="_self">FS_DMA_NOT_USE</A></TH> 608 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 609<TD>Used when you specify transfer by the CPU instead of a DMA channel.</TD> 610 </TR> 611 <TR> 612<TH><A href="fs_archive_proc_consts.html" target="_self">FS_ARCHIVE_PROC_*</A></TH> 613 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 614<TD>Used when you specify the user procedure of the archive.</TD> 615 </TR> 616 <TR> 617<TH><A href="FS_FILEMODE.html" target="_self">FS_FILEMODE_*</A></TH> 618 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 619<TD>Constants used to specify the mode for accessing files.</TD> 620 </TR> 621 <TR> 622<TH><A href="FS_DIRMODE.html" target="_self">FS_DIRMODE_*</A></TH> 623 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 624<TD>Constants used to specify the mode for accessing directories.</TD> 625 </TR> 626 <TR> 627<TH><A href="FS_PERMIT.html" target="_self">FS_PERMIT_*</A></TH> 628 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 629<TD>Constants used to set access rights for files.</TD> 630 </TR> 631 </TBODY> 632</TABLE> 633<H3><A name="type">Types and Structures</A></H3> 634<TABLE border="1" width="100%"> 635 <TBODY> 636 <TR> 637<TH width="25%"><A href="fs_file_type.html" target="_self">FSFile</A></TH> 638 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 639<TD>Used for file access.</TD> 640 </TR> 641 <TR> 642<TH width="25%"><A href="FSDirectoryEntryInfo.html" target="_self">FSDirectoryEntryInfo[W]</A></TH> 643 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 644<TD>Stores directory entry information.</TD> 645 </TR> 646 <TR> 647<TH width="25%"><A href="FSPathInfo.html" target="_self">FSPathInfo</A></TH> 648 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 649<TD>Stores path entry information.</TD> 650 </TR> 651 <TR> 652<TH width="25%"><A href="FSArchiveResource.html" target="_self">FSArchiveResource</A></TH> 653 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 654<TD>Stores an archive's resource information.</TD> 655 </TR> 656 <TR> 657<TH width="25%"><A href="FSDateTime.html" target="_self">FSDateTime</A></TH> 658 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 659<TD>Expresses date and time.</TD> 660 </TR> 661 <TR> 662<TH width="25%"><A href="fs_dir_pos_type.html" target="_self">FSDirPos</A></TH> 663 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 664<TD>Expresses a directory position.</TD> 665 </TR> 666 <TR> 667<TH width="25%"><A href="fs_file_id_type.html" target="_self">FSFileID</A></TH> 668 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 669<TD>Expresses a unique file ID.</TD> 670 </TR> 671 <TR> 672<TH><A href="fs_command_type_const.html" target="_self">FSCommandType</A></TH> 673 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 674<TD>Expresses the command ID to be sent to the archive.</TD> 675 </TR> 676 <TR> 677<TH><A href="fs_archive_rw_func_type.html" target="_self">FS_ARCHIVE_READ_FUNC</A></TH> 678 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 679<TD>Expresses the format of the Read callback function to be specified in the archive.</TD> 680 </TR> 681 <TR> 682<TH><A href="fs_archive_rw_func_type.html" target="_self">FS_ARCHIVE_WRITE_FUNC</A></TH> 683 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 684<TD>Expresses the format of the write callback function to be specified in the archive.</TD> 685 </TR> 686 <TR> 687<TH><A href="fs_archive_type.html" target="_self">FSArchive</A></TH> 688 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 689<TD>Used for the construction of the archive.</TD> 690 </TR> 691 <TR> 692<TH width="25%"><A href="fs_overlay_id_types.html" target="_self">FSOverlayID</A></TH> 693 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 694<TD>Expresses an overlay module's ID.</TD> 695 </TR> 696 <TR> 697<TH width="25%"><A href="fs_overlay_info_type.html" target="_self">FSOverlayInfo</A></TH> 698 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 699<TD>Stores the overlay module information.</TD> 700 </TR> 701 <TR> 702<TH width="25%"><A href="fs_overlay_id_types.html" target="_self">FS_EXTERN_OVERLAY</A></TH> 703 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 704<TD>This macro declares an overlay module's ID.</TD> 705 </TR> 706 <TR> 707<TH width="25%"><A href="fs_overlay_id_types.html" target="_self">FS_OVERLAY_ID</A></TH> 708 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 709<TD>This macro defines an overlay module's ID.</TD> 710 </TR> 711 </TBODY> 712</TABLE> 713 714 715<hr><p>CONFIDENTIAL</p></body> 716</HTML>
