FS_GetArchiveResultCode

Syntax


#include <nitro/fs.h>

FSResult FS_GetArchiveResultCode(const void *path_or_archive);

Arguments

path_or_archive Either a pointer to an FSArchive structure, or a string indicating the path (including the target archive name). For example, specifying rom: indicates the ROM archive, and specifying sdmc:/foo.txt indicates an SD card archive. Note: Specifying just the archive name without including the colon (for example, "rom") will be treated as a relative path.

Return Values

Gets the result of the last process executed by the specified archive. FS_RESULT_ERROR will be returned if the specified pointer is neither an archive nor a valid path string.

Description

Gets the result of the last process executed by the specified archive. FS_RESULT_ERROR 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.

If you want to get the result of the last operation that was performed on a specific file handle, use FS_GetResultCode().

See Also

FSArchive
FSResult
FS_GetResultCode

Revision History

2008/07/14 Added an example and caution about the path_or_archive argument.
2007/11/02 Initial version.


CONFIDENTIAL