Struct CriFs.IoInterface

I/Oインターフェイス

Inherited Members
Namespace: CriWare
Assembly: CriWare.CriFs.dll
Syntax
public struct CriFs.IoInterface

Fields

CanParallelRead

複数の同時ファイルアクセス要求が可能かどうかの問い合わせ

Declaration
public delegate* unmanaged[Cdecl]<NativeBool*, CriFs.IoError> CanParallelRead
Field Value
Type Description
delegate* unmanaged[Cdecl]<NativeBool*, IoError>
Remarks

説明: このI/Oインターフェースが複数の同時ファイルアクセス要求が可能であるかどうかを返す関数です。 本関数を実装しない場合、不可能であるとみなされます。 本関数を実装されていて、result が true だった場合、 criFsLoader は効率よく複数ファイルのロードを行うために並列でリード要求を行うようになります。

備考: 並列でリード要求を行う場合、CriFs.FileIoMode が OpenEveryTime である必要があります。

CancelRead

ファイル読み込みのキャンセル発行

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, CriFs.IoError> CancelRead
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, IoError>

エラーコード
Remarks

説明: デバイス側のファイル読み込みに対してキャンセルを発行し、即時に復帰する関数です。 戻り値は Ok を返してください。 Ok以外の値を返しても、 CRI File Systemの動作はOkを返した場合と同じです。

CancelWrite

ファイル書き込みのキャンセル発行

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, CriFs.IoError> CancelWrite
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, IoError>

エラーコード
Remarks

説明: デバイス側のファイル書き込みに対してキャンセルを発行し、即時に復帰する関数です。 戻り値は Ok を返してください。 Ok以外の値を返しても、 CRI File Systemの動作はOkを返した場合と同じです。

Close

ファイルのクローズ

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, CriFs.IoError> Close
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, IoError>

エラーコード
Remarks

説明: 指定されたファイルオブジェクトをクローズする関数です。 ファイルオープン時に動的にメモリの確保を行なった場合は、クローズ時にメモリを解放してください。

Exists

ファイルの有無の確認

Declaration
public delegate* unmanaged[Cdecl]<NativeString, NativeBool*, CriFs.IoError> Exists
Field Value
Type Description
delegate* unmanaged[Cdecl]<NativeString, NativeBool*, IoError>

エラーコード
Remarks

説明: 指定されたファイルの有無を確認する関数です。 ファイルが存在する場合は true を、 存在しない場合は false を result にセットする必要があります。

Flush

フラッシュの実行

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, CriFs.IoError> Flush
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, IoError>

エラーコード
Remarks

説明: 書き込み用にバッファーリングされているデータを、 強制的にデバイスに書き出す処理を行う関数です。 （ ANSI C 標準の API では fflush 関数に相当する処理です。）

備考: デバイスで書き込みを行なわない場合には、この関数を実装せず、 構造体のメンバーに CRI_NULL を指定することも可能です。

GetFileSize

ファイルサイズの取得

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, long*, CriFs.IoError> GetFileSize
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, long*, IoError>

エラーコード
Remarks

説明: 指定されたファイルオブジェクトから、当該ファイルのサイズを取得する関数です。

注意: この関数はメインスレッド上から直接実行される可能性があります。 そのため、この関数の中で長時間処理をブロックすることは避ける必要があります。 ファイルオブジェクトからファイルサイズを取得するのに時間がかかる場合には、 ファイルオープン時にあらかじめファイルサイズを取得（ファイルオブジェクト内に保持） しておき、本関数実行時にその値を返すよう関数を実装してください。

GetNativeFileHandle

ネイティブファイルオブジェクトの取得

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, IntPtr, CriFs.IoError> GetNativeFileHandle
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, IntPtr, IoError>

エラーコード
Remarks

説明: プラットフォームSDKで利用されるファイルのオブジェクトを取得する関数です。 例えば、 ANSI C 標準の fopen 関数を使用してファイルをオープンした場合、 native_filehn としてファイルポインター（ FILE * ）を返す必要があります。

備考: 現状、PLAYSTATION3以外の機種ではこの関数を実装する必要はありません。

GetReadSize

読み込みサイズの取得

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, long*, CriFs.IoError> GetReadSize
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, long*, IoError>

エラーコード
Remarks

説明: リード処理を行なった結果、実際にバッファーに読み込めたデータのサイズを返す関数です。 ファイルの終端等では、 Read 関数で指定したサイズ分のデータが必ずしも読み込めるとは限りません。

注意: リードエラーが発生した場合、 read_size に -1 をセットし、 関数の戻り値は Ok を返してください。

GetWriteSize

書き込みサイズの取得

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, long*, CriFs.IoError> GetWriteSize
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, long*, IoError>

エラーコード
Remarks

説明: ライト処理を行なった結果、実際にバッファーに読み込めたデータのサイズを返す関数です。

注意: ライトエラーが発生した場合、 write_size に -1 をセットし、 関数の戻り値は Ok を返してください。

備考: デバイスで書き込みを行なわない場合には、この関数を実装せず、 構造体のメンバーに CRI_NULL を指定することも可能です。

IsReadComplete

読み込み完了チェック

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, NativeBool*, CriFs.IoError> IsReadComplete
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, NativeBool*, IoError>

エラーコード
Remarks

説明: ファイルの読み込みが完了したかどうかを確認する関数です。 ファイルの読み込みが完了した場合は true を、 読み込み途中の場合は false を result にセットする必要があります。

注意: result には、リード処理の成否に関係なく、リード処理が完了した時点 （デバイスへのアクセスが終了した時点）で true をセットする必要があります。 リードエラーが発生した場合でも、 result に true をセットし、 関数の戻り値は Ok を返してください。 （リード処理が成功したかどうかについては、 GetReadSize 関数で判別しています。） result に false を返す限りは、CRI File System ライブラリは他の読み込み要求を一切処理しません。 （リードエラー発生時に result に false をセットし続けた場合、 ファイルのロードができなくなったり、オブジェクトの Destroy 関数から処理が復帰しなくなる可能性があります。

IsWriteComplete

書き込み完了チェック

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, NativeBool*, CriFs.IoError> IsWriteComplete
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, NativeBool*, IoError>

エラーコード
Remarks

説明: ファイルの書き込みが完了したかどうかを確認する関数です。 ファイルの書き込みが完了した場合は true を、 書き込み途中の場合は false を result にセットする必要があります。

注意: ライトエラーが発生した場合、 result に true をセットし、 関数の戻り値は Ok を返してください。

備考: デバイスで書き込みを行なわない場合には、この関数を実装せず、 構造体のメンバーに CRI_NULL を指定することも可能です。

注意: result には、ライト処理の成否に関係なく、ライト処理が完了した時点 （デバイスへのアクセスが終了した時点）で true をセットする必要があります。 ライトエラーが発生した場合でも、 result に true をセットし、 関数の戻り値は Ok を返してください。 （ライト処理が成功したかどうかについては、 GetReadSize 関数で判別しています。） result に false を返す限りは、CRI File System ライブラリは他の読み込み要求を一切処理しません。 （ライトエラー発生時に result に false をセットし続けた場合、 ファイルのロードができなくなったり、オブジェクトの Destroy 関数から処理が復帰しなくなる可能性があります。

Open

ファイルのオープン

Declaration
public delegate* unmanaged[Cdecl]<NativeString, CriFs.FileMode, CriFs.FileAccess, IntPtr*, CriFs.IoError> Open
Field Value
Type Description
delegate* unmanaged[Cdecl]<NativeString, FileMode, FileAccess, IntPtr*, IoError>

エラーコード
Remarks

説明: 指定されたファイルをオープンする関数です。 オープンに成功した場合、CriFs.FileHn 型のファイルオブジェクトを返す必要があります。

補足: CriFs.FileHn は void ポインターとして定義されています。 独自のファイル情報構造体を定義し、そのアドレスを CriFs.FileHn 型にキャストして返してください。 尚、ファイルオープン時にメモリの確保が必要な場合には、本関数内で動的にメモリの確保を行なってください。

注意: 戻り値のエラーコード（ CriFs.IoError ）には、関数内で継続不能なエラーが発生した 場合に限り Ng をセットしてください。 （ファイルのオープンに失敗した場合でも、アプリケーションで処理を継続可能な場合には filehn に null をセットし、Ok を返す必要があります。） また、ディスク挿入待ち等の理由により、関数が実行されたタイミングでオープン処理 を実行できない場合、エラーコードとして TryAgain を返すことで、 一定時間後（約10ms後）に再度オープン処理をやり直すことが可能です。 （関数の実行タイミングを先送りすることが可能です。）

Read

読み込みの開始

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, long, long, IntPtr, long, CriFs.IoError> Read
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, long, long, IntPtr, long, IoError>

エラーコード
Remarks

説明: データの読み込みを開始する関数です。 offset で指定された位置から、 read_size で指定されたサイズ分だけデータを buffer に読み込みます。 関数のインターフェイスとしては非同期I/O処理による実装を想定していますが、 スレッドを使用する場合（スレッドモデルに Multi を指定する場合） には、この関数を同期I/O処理を使って実装しても問題ありません。 （関数内でファイルの読み込みを完了するまで待っても問題ありません。）

注意: 実際に読み込めたサイズは、 GetReadSize 関数で返す必要があります。 同期I/O処理により本関数を実装する場合でも、読み込めたサイズは GetReadSize 関数 が実行されるまで、ファイルオブジェクト内に保持する必要があります。

Remove

ファイルの削除

Declaration
public delegate* unmanaged[Cdecl]<NativeString, CriFs.IoError> Remove
Field Value
Type Description
delegate* unmanaged[Cdecl]<NativeString, IoError>

エラーコード
Remarks

説明: 指定されたファイルを削除する関数です。

備考: デバイスで書き込みを行なわない場合には、この関数を実装せず、 構造体のメンバーに CRI_NULL を指定することも可能です。

Rename

ファイル名の変更

Declaration
public delegate* unmanaged[Cdecl]<NativeString, NativeString, CriFs.IoError> Rename
Field Value
Type Description
delegate* unmanaged[Cdecl]<NativeString, NativeString, IoError>

エラーコード
Remarks

説明: ファイル名の変更を行なう関数です。 old_path で指定されたファイルを、 new_path にリネームします。

備考: デバイスで書き込みを行なわない場合には、この関数を実装せず、 構造体のメンバーに CRI_NULL を指定することも可能です。

Resize

ファイルサイズの変更

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, long, CriFs.IoError> Resize
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, long, IoError>

エラーコード
Remarks

説明: ファイルのサイズを指定したサイズに変更する関数です。

補足: 本関数は、DMA転送サイズの制限等によりデバイスへの書き込みがバイト単位で 行なえない場合に、ファイルサイズを補正するために使用します。 そのため、書き込みがバイト単位で可能なデバイスについては、この関数を実装せず、 構造体のメンバーに CRI_NULL を指定することも可能です。

備考: デバイスで書き込みを行なわない場合には、この関数を実装せず、 構造体のメンバーに CRI_NULL を指定することも可能です。

SetAddReadProgressCallback

読み込みプログレス加算コールバックの設定

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, delegate* unmanaged[Cdecl]<IntPtr, int, void>, IntPtr, CriFs.IoError> SetAddReadProgressCallback
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, delegate* unmanaged[Cdecl]<IntPtr, int, void>, IntPtr, IoError>
Remarks

説明: 本関数は、GetProgress(out long, out long) で得られる進捗を、単位読み込みサイズより 細かい粒度で更新させるための、読み込みプログレス加算コールバックを設定する関数です。 本関数を実装しない場合や、本関数で渡されたコールバック関数を使用しない場合、 GetProgress(out long, out long) で得られる進捗は、基本的に単位読み込みサイズ毎に更新されます。 本関数を実装する場合は、渡されたコールバック関数を Read 関数内で呼び出してください。 また、呼び出す際には第一引数に obj、第二引数にメモリへの読み込みが完了したサイズを バイト単位で渡してください。 例えば、リード要求をデバイス内で 8192byte ずつに分割して読み込む場合は、 8192byte の読み込み完了毎に、第二引数に 8192 を渡して呼び出してください。 この、読み込みプログレス加算コールバック呼び出しによって GetProgress(out long, out long) で得られる進捗が更新されます。単位読み込みサイズより細かい粒度で更新を 行うことで GetProgress(out long, out long) で得られる進捗の粒度が細かくなります。

備考: 読み込みリクエストより細かい粒度で読み込み進捗を取得できない場合は、 実装するメリットはありません。

Write

書き込みの開始

Declaration
public delegate* unmanaged[Cdecl]<IntPtr, long, long, IntPtr, long, CriFs.IoError> Write
Field Value
Type Description
delegate* unmanaged[Cdecl]<IntPtr, long, long, IntPtr, long, IoError>

エラーコード
Remarks

説明: データの書き込みを開始する関数です。 offset で指定された位置から、 write_size で指定されたサイズ分だけデータを buffer から書き込みます。 関数のインターフェイスとしては非同期I/O処理による実装を想定していますが、 スレッドを使用する場合（スレッドモデルに Multi を指定する場合） には、この関数を同期I/O処理を使って実装しても問題ありません。 （関数内でファイルの書き込みを完了するまで待っても問題ありません。）

注意: 実際に書き込めたサイズは、 GetWriteSize 関数で返す必要があります。 同期I/O処理により本関数を実装する場合でも、書き込めたサイズは GetWriteSize 関数 が実行されるまで、ファイルオブジェクト内に保持する必要があります。

備考: デバイスで書き込みを行なわない場合には、この関数を実装せず、 構造体のメンバーに CRI_NULL を指定することも可能です。