FS_GetArchiveResultCode

構文


#include <nitro/fs.h>

FSResult FS_GetArchiveResultCode(const void *path_or_archive);

引数

path_or_archive FSArchive構造体へのポインタか、または対象アーカイブ名を含むパス文字列。
例えば "rom:" を指定した場合はROMアーカイブを、"sdmc:/foo.txt" を指定した場合はSDカードアーカイブを指します。
"rom"などのようにコロンを含まずアーカイブ名だけを指定すると相対パスになってしまうという点にご注意ください。

返り値

指定したアーカイブが最後に行った処理の結果を返します。
指定したポインタがアーカイブでも有効なパス文字列でもない場合はFS_RESULT_ERRORを返します。

説明

指定したアーカイブが最後に行った処理の結果を返します。
指定したポインタがアーカイブでも有効なパス文字列でもない場合はFS_RESULT_ERRORを返します。
処理中のアーカイブに対してこの関数を呼び出した場合、結果は未定義です。

特定のファイルハンドルが最後に行った処理の結果を取得したい場合は、FS_GetResultCode() をご使用ください。

参照

FSArchive FSResult
FS_GetResultCode

履歴

2008/07/14 引数path_or_archiveに関する例示と注意事項の追記
2007/11/02 初版