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>FS_GetArchiveResultCode</title> 7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" /> 8</head> 9<body> 10 11<h1 style="text-align:left">FS_GetArchiveResultCode <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1> 12<h2>Syntax</h2> 13 14<pre><code> 15#include <nitro/fs.h> 16 17<a href="../fs_result_const.html">FSResult</a> FS_GetArchiveResultCode(const void *path_or_archive); 18</code></pre> 19 20<h2>Arguments</h2> 21<table style="width:100%"> 22 <tbody> 23 <tr> 24<td style="width:13%"><em><strong>path_or_archive</strong></em></td> 25<td style="width:87%">Either a pointer to an <code>FSArchive</code> structure, or a string indicating the path (including the target archive name). For example, specifying <code>rom:</code> indicates the <a href="../archive_rom_spec.html">ROM archive</a>, and specifying <code>sdmc:/foo.txt</code> indicates an <a href="../archive_sdmc_spec.html">SD card archive</a>. <B>Note:</B> Specifying just the archive name without including the colon (for example, "<code>rom</code>") will be treated as a relative path.</span></td> 26 </tr> 27 </tbody> 28</table> 29 30<h2>Return Values</h2> 31<p>Gets the result of the last process executed by the specified archive. <a href="../fs_result_const.html"><code>FS_RESULT_ERROR</code></a> will be returned if the specified pointer is neither an archive nor a valid path string. 32</p> 33 34<h2>Description</h2> 35<p>Gets the result of the last process executed by the specified archive. <a href="../fs_result_const.html"><code>FS_RESULT_ERROR</code></a> will be returned if the specified pointer is neither an archive nor a valid path string. The result is undefined if this function is called on an archive for which a process is being performed. 36</p> 37<p>If you want to get the result of the last operation that was performed on a specific file handle, use <code><a href="../file/FS_GetResultCode.html">FS_GetResultCode()</a></code>. 38</p> 39 40 41<h2>See Also</h2> 42<p><code><a href="../fs_archive_type.html">FSArchive</a><BR> <a href="../fs_result_const.html">FSResult</a><br /> <a href="../file/FS_GetResultCode.html">FS_GetResultCode</a></code></p> 43 44<h2>Revision History</h2> 45<p> 462008/07/14 Added an example and caution about the <code>path_or_archive</code> argument.<br />2007/11/02 Initial version.<br /> 47</p> 48<hr><p>CONFIDENTIAL</p></body> 49</html> 50
