FS_SeekFile

構文

#include <nitro/fs.h>

BOOL FS_SeekFile( FSFile *p_file, s32 offset, FSSeekMode origin );

引数

p_file FSFile構造体のアドレス
offset 移動するバイトサイズ(先頭から終端へを正方向とします)
origin 移動の基準位置

返り値

ファイルポインタが正しく移動されれば TRUE を返し、そうでない場合は FALSE を返します。

説明

origin で指定した基準位置から offset 分を加算した位置にファイルポインタを移動します。
origin の種類は、FSSeekFileMode型で定義されています。

指定した新しい位置がファイルの先頭または終端の範囲を超えてしまう場合、 得られる結果はNITRO-SDKとTWL-SDKで異なりますのでご注意ください。

NITRO-SDKファイルポインタは先頭または終端の範囲内におさまるよう補正されます。
TWL-SDK処理は失敗してFALSEを返し、FS_GetResultCode()FS_RESULT_INVALID_PARAMETERを返します。

参照

FSFile FSSeekFileMode FS_GetFileLength FS_ReadFile FS_SeekFileToBegin FS_SeekFileToEnd

履歴

2009/07/29 範囲外へ移動した際の挙動がNITRO-SDKとTWL-SDKで異なる旨の注意を追記
2008/10/02 参照リストを一部更新
2004/04/01 初版