8.関数仕様-2

8.2　ファイル操作

一 覧 表

Title 関数仕様

Function ファイルのオープン

Function Name GFS_Open

No 2.1

　書　式

GfsHn GFS_Open(Sint32 fid)

　入　力

fid：ファイル識別子

　出　力

なし

　関数値

ファイルハンドル。エラーの場合はNULLを返します。

　機　能

指定されたファイルをオープンし、ファイルハンドルを返します。

一 覧 表

Title 関数仕様

Function ファイルのクローズ

Function Name GFS_Close

No 2.2

　書　式

void GFS_Close(GfsHn gfs)

　入　力

gfs：ファイルハンドル

　出　力

なし

　関数値

なし

　機　能

指定されたファイルハンドルをクローズします。

一 覧 表

Title 関数仕様

Function アクセスポインタの移動

Function Name GFS_Seek

No 2.3

　書　式

Sint32 GFS_Seek(GfsHn gfs, Sint32 off, Sint32 org)

　入　力

gfs	：ファイルハンドル
off	：アクセスポインタの移動量 (セクタ単位)
org	：移動の基準(シークモード：GFS_SEEK_〜)

　出　力

なし

　関数値

移動後のアクセスポインタの位置。エラーがあった場合は負のエラーコード。

　機　能

アクセスポインタをorgからoffセクタ離れた位置に移動させます。
アクセスポインタとしてファイルの範囲外を指定することはできません。

一 覧 表

Title 関数仕様

Function アクセスポインタの取得

Function Name GFS_Tell

No 2.4

　書　式

Sint32 GFS_Tell(GfsHn gfs)

　入　力

gfs：ファイルハンドル

　出　力

なし

　関数値

アクセスポインタの位置。エラーの場合は負のエラーコード。

　機　能

アクセスポインタの位置を取得します。

一 覧 表

Title 関数仕様

Function ファイル終了のチェック

Function Name GFS_IsEof

No 2.5

　書　式

Bool GFS_IsEof(GfsHn gfs)

　入　力

gfs：ファイルハンドル

　出　力

なし

　関数値

ファイル末フラグ。

　機　能

アクセスポインタがファイルの終わりに到達したか否かをチェックします。関数値は次の意味を持ちます。

TRUE	：ファイル末に達しています。
FALSE	：ファイル末に達していません。

不正なファイルハンドルが入力された場合はファイル末に達しているとみなします。

一 覧 表

Title 関数仕様

Function バイトサイズからセクタ長への変換

Function Name GFS_ByteToSct

No 2.6

　書　式

Sint32 GFS_ByteToSct(GfsHn gfs, Sint32 nbyte)

　入　力

gfs	：ファイルハンドル
nbyte	：バイト数

　出　力

なし

　関数値

セクタ数。エラーのときは負のエラーコード。

　機　能

単位をバイトからセクタ (nsct) に変換します。セクタ単位の長さnsctは次の計算式で求めます。

nsct＝(nbyte＋ファイルのセクタ長−１)／ファイルのセクタ長;

セクタ長が不定の場合(Form1, Form2 の混在) は、0 が関数値となります。

一 覧 表

Title 関数仕様

Function ファイルサイズの取得

Function Name GFS_GetFileSize

No 2.7

　書　式

void GFS_GetFileSize(GfsHn gfs, Sint32 *sctsize, Sint32 *nsct,Sint32 *lastsize)

　入　力

gfs ：ファイルハンドル

　出　力

sctsize	：セクタ長
nsct	：セクタ数(最終セクタを含む)
lastsize	：最終セクタ中にファイルデータの占めるバイト数

　関数値

なし

　機　能

ファイルの大きさを求めるための情報を取得します。sctsize, nsct, lastsizeにはNULLを指定すると、その情報の出力を抑制できます。ファイルの大きさ(fsize)は、以下の式で求められます。
　fsize＝sctsize＊(nsct−１)＋lastsize;

　備　考

Form1、Form2の混在するファイルでは、sctsize、lastsizeとも０になります。

一 覧 表

Title 関数仕様

Function ファイル情報の取得

Function Name GFS_GetFileInfo

No 2.8

　書　式

void GFS_GetFileInfo(GfsHn gfs, Sint32 *fid, Sint32 *fn, Sint32 *fsize,Sint32 *atr)

　入　力

gfs ：ファイルハンドル

　出　力

fid	：ファイル識別子
fn	：ファイル番号
fsize	：ファイルの大きさ(単位：バイト)
atr	：ファイル属性

　関数値

なし

　機　能

ファイル情報を取得します。fid, fn, fsize, atrにはNULLを指定すると、その情報の出力を抑制できます。ファイルの大きさはディレクトリ情報に記録されている値なので、1セクタの大きさは2048バイトとして計算されています。

一 覧 表

Title 関数仕様

Function CDバッファ区画のセクタ数の取得

Function Name GFS_GetNumCdbuf

No 2.9

　書　式

Sint32　GFS_GetNumCdbuf(GfsHn gfs)

　入　力

gfs：ファイルハンドル

　出　力

なし

　関数値

CDバッファ区画内のセクタ数

　機　能

CDバッファ区画内に存在するセクタ数を取得します。