osPfsReadWriteFile.htm 4.28 KB

Raw Blame History Permalink

<HTML>
<HEAD>
<TITLE>HTML 文書</TITLE>
<META NAME="GENERATOR" CONTENT="mitu">
</HEAD>

<BODY>

<P>
<B><FONT FACE="Arial">osPfsReadWriteFile(3P)<BR>
</FONT></B>
<P>
<B>関数名<BR>
</B>
<P>
osPfsReadWriteFile
<P>
→ ゲームノートのゲームデータの書き込み／読み込み<BR>

<P>
<B>構文<BR>
</B>
<P>
#include &lt;ultra64.h&gt;<BR>

<P>
<B>s32 osPfsReadWriteFile(OSPfs *pfs,  s32 file_no,  u8 flag,  int offset,  int nbytes,  u8 * data_buffer);<BR></B>

<P>
<B>説明<BR>
</B>
<P>
関数osPfsReadWriteFileは、指定のゲームノートにデータを読み書きするための関数です。flagにPFS_READを指定すればゲームノートからの読み込み、PFS_WRITEを指定すればゲームノートへの書き込みとなります。
<BR>

<P>
読み込みの場合は、ゲームデータ領域のoffsetバイト目からnbytesバイト分のデータが、ポインタdata_bufferで指し示される領域に格納されます。書き込みの場合には、ポインタdata_bufferで指し示される領域のnbyteバイトのデータが、ゲームデータ領域のoffsetバイト目から書き込まれます。offsetとnbytesは両方ともBLOCKSIZE（32バイト）の倍数でかつ、ファイルサイズよりも小さくなければいけません。もちろん、確保している領域外の部分を読み書きするようなパラメータを設定してはいけません。
<BR>

<P>
file_noはノート番号（ファイルディスクリプタ）です。関数<A HREF="osPfsAllocateFile.htm">osPfsAllocateFile</A>,(3P)、あるいは、<A HREF="osPfsFindFile.htm">osPfsFindFile</A>,(3P)を呼び出して値を取得してください。
<BR>

<P>
OSPfs構造体pfsは関数osPfsInitPakによって初期化されるファイルハンドルです。このハンドルの作成方法は、<A HREF="osPfsInitPak.htm">osPfsInitPak</A>,(3P)を参照してください。
<BR>

<P>
関数の呼び出しに成功すれば、返り値として0が返されます。エラーが発生した場合には、以下に示すエラーコードのいずれかが返されます。
<BR>
<P>
<B>PFS_ERR_NOPACK</B>
<P>
指定したコントローラにコントローラパックが挿し込まれていません。あるいは、コントローラが挿し込まれていないなど、何らかのPIfエラーが発生しました。このどちらであるのかを調べる場合には、<A HREF="osContStartQuery.htm">osContStartQuery</A>,(3P)＆<A HREF="osContGetQuery.htm">osContGetQuery</A>,(3P)などを使用してください。
<BR>
<P>
<B>PFS_ERR_NEW_PACK</B>
<P>
コントローラパックが別のコントローラパックに挿し替わっています。このまま、このコントローラパックを使用する場合には、<A HREF="osPfsInitPak.htm">osPfsInitPak</A>,(3P)を呼び出して、コントローラパックを初期化してください。
<BR>
<P>
<B>PFS_ERR_INCONSISTENT</B>
<P>
ファイルシステムの管理領域に異常があります。<A HREF="osPfsInitPak.htm">osPfsInitPak</A>,(3P)でのファイルシステム初期化時に、内部で<A HREF="osPfsChecker.htm">osPfsChecker</A>,(3P)を呼び出していますので、通常このエラーが発生することはありません。このエラーが返る場合、正しく接続されていないか、あるいは、コントローラパック自体に異常がある可能性があります。
<BR>
<P>
<B>PFS_ERR_CONTRFAIL</B>
<P>
コントローラとのデータ転送の失敗です。関数の内部では、転送エラーが発生した場合、最大3回転送のやり直しを行っています。そのため、このエラーが発生することはあまりありません。このエラーが返る場合、コントローラが正しく接続されていないか、あるいは、コントローラパックかコントローラコネクタに異常がある可能性があります。
<BR>
<P>
<B>PFS_ERR_INVALID</B>
<P>
関数呼び出し時に指定したパラメータに誤りがあるか、指定したゲームノートが存在しないか、<A HREF="osPfsInitPak.htm">osPfsInitPak</A>,(3P)で初期化を行わずにPfs関数を呼び出したかのいずれかです。そのため、通常このエラーが返ることはありません。
<BR>
<P>
<B>PFS_ERR_BAD_DATA</B>
<P>
まだ、データを書き込んでいないにもかかわらず、関数osPfsReadWriteFileでデータ読み込みを行おうとした場合に発生します。
<BR>
<P>
データを書き込むと、ファイル情報領域中のステータスに、PFS_WRITEというビットがセットされます。データ読み込み時にこのステータスを見て、もし、このビットがセットされていない場合はこのエラーを返します。
<BR>
<P>
<B>参照<BR>
</B>
<A HREF="osContInit.htm">osContInit</A>(3P),
<A HREF="osContStartQuery.htm">osContStartQuery</A>(3P),
<A HREF="osContGetQuery.htm">osContGetQuery</A>(3P),
<A HREF="osPfsAllocateFile.htm">osPfsAllocateFile</A>(3P),
<A HREF="osPfsChecker.htm">osPfsChecker</A>(3P),
<A HREF="osPfsDeleteFile.htm">osPfsDeleteFile</A>(3P),
<A HREF="osPfsFileState.htm">osPfsFileState</A>(3P),
<A HREF="osPfsFindFile.htm">osPfsFindFile</A>(3P),
<A HREF="osPfsFreeBlocks.htm">osPfsFreeBlocks</A>(3P),
<A HREF="osPfsInitPak.htm">osPfsInitPak</A>(3P),
<A HREF="osPfsIsPlug.htm">osPfsIsPlug</A>(3P),
</BODY>

</HTML>