以下に示す定数は、ハンドルの状態を示す。

以下に示す定数は、アクセスポインタを移動する際の基準を示す。ADXF_Seek関数の引数として使用する。

n ：AFSファイル内のインサイドファイルの数

なし

パーティション情報領域サイズ(単位：バイト)

指定されたファイル数からパーティション情報領域サイズを計算する。

以下の関数のptinfoに対して使用する。

ADXF_LoadPartitionNw

ADXF_LoadPartitionFromAfsNw

n ：AFSファイル内のインサイドファイルの数

なし

パーティション情報領域サイズ(単位：バイト)

指定されたファイル数からパーティション情報領域サイズを計算する。

以下の関数のptinfoに対して使用する。

ADXF_LoadPartitionFmgLongNw

ADXF_LoadPartitionFromAfsFmgLongNw

ファイルアクセスに関する、ファイル毎の情報を保持する。ADXF_Open,ADXF_OpenAfs関数によって生成される。ファイルアクセスのほとんどの関数がこのデータを参照する。

なし

なし

なし

ライブラリを初期化する。

ADXT_Init関数(ADX再生ライブラリの初期化)から呼び出されるため、アプリケーション側から呼び出す必要はない。

なし

なし

なし

ライブラリの終了処理をする。

ADXT_Finish関数(ADX再生ライブラリの終了処理)から呼び出されるため、アプリケーション側から呼び出す必要はない。

ptid：パーティションID

なし

パーティション情報のサイズ(単位：バイト)

設定したパーティション情報のサイズを取得する。

この関数はパーティション情報の読み込み後にのみ有効である。

ptid ：パーティションID(0〜255)

fname ：AFSファイルの名前

dir ：ディレクトリ情報(NULL：カレントディレクトリ)

ptinfo：パーティション情報読み込み領域

エラーコード

AFSファイルのパーティション情報の読み込みリクエストを発行する。

この関数を実行後は、ADXF_GetPtStat関数で状態を監視し、パーティション情報の読み込み終了を待つ。終了状態になった後、そのパーティションは使用可能になる。

１ファイル当たり２バイトでファイルを管理している。パーティション情報領域(ptinfo)サイズの計算にはADXF_CALC_PTINFO_SIZEを使用する。

// sample.afsをパーティションロード
ADXF_LoadPartitionNw(0, "sample.afs", NULL, ptinfo);
for (;;) {
    if (ADXF_GetPtStat(0) == ADXF_STAT_READEND) {
        break;
    }
    ADXM_ExecMain();
}

ptid ：パーティションID(0〜255)

fname ：AFSファイルの名前

dir ：ディレクトリ情報(NULL：カレントディレクトリ)

offset_sct：ファイル内のオフセット（セクタ単位）

range_sct ：範囲（セクタ単位）

ptinfo：パーティション情報読み込み領域

エラーコード

指定された範囲をAFSファイルとして、パーティション情報の読み込みリクエストを発行する。

この関数を実行後は、ADXF_GetPtStat関数で状態を監視し、パーティション情報の読み込み終了を待つ。終了状態になった後、そのパーティションは使用可能になる。

１ファイル当たり２バイトでファイルを管理している。パーティション情報領域(ptinfo)サイズの計算にはADXF_CALC_PTINFO_SIZEを使用する。

// sample.dat内の200セクタから1000セクタをAFSファイルとしてパーティションロード
ADXF_LoadPartitionRangeNw(0, "sample.dat", NULL, 200, 1000, ptinfo);
for (;;) {
    if (ADXF_GetPtStat(0) == ADXF_STAT_READEND) {
        break;
    }
    ADXM_ExecMain();
}

set_ptid：読み込むAFSファイルに対して設定するパーティションID(0〜255)

rd_ptid ：読み込むAFSファイルのパーティションID

rd_flid ：読み込むAFSファイルのファイルID

ptinfo ：パーティション情報読み込み領域

エラーコード

AFSファイルのパーティション情報の読み込みリクエストを発行する。

この関数を実行後は、ADXF_GetPtStat関数で状態を監視し、パーティション情報の読み込み終了を待つ。終了状態になった後、そのパーティションは使用可能になる。

１ファイル当たり２バイトでファイルを管理している。パーティション情報領域(ptinfo)サイズの計算にはADXF_CALC_PTINFO_SIZEを使用する。

この関数は、AFSファイル内のAFSファイルに対してパーティション情報を読み込む時に使用する。rd_ptidとrd_flidで指定されたAFSファイルをset_ptidのパーティションとして扱うことができる。ADXF_LoadPartitionNw関数使用時と同様に、set_ptidのパーティションに対してADXF_OpenAfs関数でインサイドファイルを開くことができる。

// sample.afsをパーティションロード
ADXF_LoadPartitionNw(0, "sample.afs", NULL, ptinfo1);
for (;;) {
    if (ADXF_GetPtStat(0) == ADXF_STAT_READEND) {
        break;
    }
    ADXM_ExecMain();
}
// sample.afs内のファイルID 0のインサイドファイルをパーティションロード
ADXF_LoadPartitionFromAfsNw(1, 0, 0, ptinfo2);
for (;;) {
    if (ADXF_GetPtStat(1) == ADXF_STAT_READEND) {
        break;
    }
    ADXM_ExecMain();
}

ptid ：パーティションID(0〜255)

fname ：AFSファイルの名前

dir ：ディレクトリ情報(NULL：カレントディレクトリ)

ptinfo：パーティション情報読み込み領域

エラーコード

AFSファイルのパーティション情報の読み込みリクエストを発行する。

この関数を実行後は、ADXF_GetPtStat関数で状態を監視し、パーティション情報の読み込み終了を待つ。終了状態になった後、そのパーティションは使用可能になる。

１ファイル当たり４バイトでファイルを管理している。ptinfoのサイズ計算にはADXF_CALC_PTINFO_FMGL_SIZEを使用する。

この関数を使用することで、128Mbyte以上のインサイドファイルを扱うことができる。

ptinfo = malloc(ADXF_CALC_PTINFO_FMGL_SIZE(100));
ADXF_LoadPartitionFmgLongNw(0, "sample.afs", NULL, ptinfo);
for (;;) {
    if (ADXF_GetPtStat(0) == ADXF_STAT_READEND) {
        break;
    }
    ADXM_ExecMain();
}

set_ptid：読み込むAFSファイルに対して設定するパーティションID(0〜255)

rd_ptid ：読み込むAFSファイルのパーティションID

rd_flid ：読み込むAFSファイルのファイルID

ptinfo ：パーティション情報読み込み領域

エラーコード

AFSファイルのパーティション情報の読み込みリクエストを発行する。

この関数を実行後は、ADXF_GetPtStat関数で状態を監視し、パーティション情報の読み込み終了を待つ。終了状態になった後、そのパーティションは使用可能になる。

１ファイル当たり４バイトでファイルを管理している。ptinfoのサイズ計算にはADXF_CALC_PTINFO_FMGL_SIZEを使用する。

この関数は、AFSファイル内のAFSファイルに対してパーティション情報を読み込む時に使用する。rd_ptidとrd_flidで指定されたAFSファイルをset_ptidのパーティションとして扱うことができる。ADXF_LoadPartitionNw関数使用時と同様に、set_ptidのパーティションに対してADXF_OpenAfs関数でインサイドファイルを開くことができる。

この関数を使用することで、128Mbyte以上のインサイドファイルを扱うことができる。

ptid ：パーティションID(0〜255)

なし

パーティション情報の読み込み状態(状態：ADXF_STAT_~)

パーティション情報の読み込み状態を取得する。

ADXF_LoadPartitionNw関数を実行後は、この関数で状態を監視し、パーティション情報 の読み込み終了を待つ。終了状態になった後、そのパーティションは使用可能になる。

なし

なし

なし

パーティション情報の読み込みを停止する。

ADXF_LoadPartitionNw関数を実行後、パーティション情報の読み込み終了前に処理を中断する場合に使用する。中断した場合、パーティション情報領域に読み込まれたデータは不正であるため、改めて読み込む必要がある。

fname ：ファイル名

atr ：ファイルの属性

なし

ADXFハンドル、エラーの場合はNULL

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

本関数は完了復帰型の関数です。指定されたファイルがオープンされるまで、関数内で処理がブロックされます。

関数内で処理がブロックされたくない場合は、各機種固有のファイル情報キャッシュを利用するか、またはADXF_OpenNw関数をご利用ください。

fname ：ファイル名

atr ：ファイルの属性

なし

ADXFハンドル、エラーの場合はNULL

ADXFハンドルを作成し、指定されたファイルのオープンを開始します。

本関数は即時復帰型の関数です。関数内で長時間処理がブロックされることはありません。

本関数はファイルオープンの成否に関係なく、ADXFハンドルを返します。ファイルのオープンに失敗した場合には、ADXFハンドルのステータスがエラー状態に遷移します。

ADXF_OpenNw関数を実行してから実際にファイルがオープンされるまでの間に以下の関数を実行した場合、下記関数内で処理がブロックされます。

・ADXF_GetFsizeSct関数

・ADXF_GetFsizeByte関数

・ADXF_GetFsizeByte64関数

・ADXF_Seek関数

・ADXF_Close関数

これらの関数内で処理がブロックされるのを回避するには、ADXF_IsOpened関数を使用してファイルがオープンされたかどうかを確認する必要があります。

/* ファイルのオープンを開始 */
adxf = ADXF_OpenNw(fname, NULL);


/* ファイルのオープン完了待ち */
for (;;) {
    /* ファイルがオープンされたかどうかチェック */
    bl_ret = ADXF_IsOpened(adxf);
    if (bl_ret != FALSE) {
        break;
    }


    /* エラーチェック */
    stat = ADXF_GetStat(adxf);
    if (stat == ADXF_STAT_ERROR) {
        /* エラー処理 */
        …
    }


    /* サーバ処理 */
    ADXM_ExecMain();
    ADXM_WatiVsync();
}


/* ファイルサイズの取得 */
nsct = ADXF_GetFsizeSct(adxf);
    :

fname ：ファイル名

atr ：ファイルの属性

offset_sct：ファイル内のオフセット（セクタ単位）

range_sct ：範囲（セクタ単位）

なし

ADXFハンドル、エラーの場合はNULL

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

ptid ：パーティションID

flid ：ファイルID

なし

ADXFハンドル、エラーの場合はNULL

パーティションIDとファイルIDで指定されたAFSファイルをオープンし、ADXFハンドルを返す。

本関数は完了復帰型の関数です。指定されたファイルがオープンされるまで、関数内で処理がブロックされます。

関数内で処理がブロックされたくない場合は、各機種固有のファイル情報キャッシュを利用するか、またはADXF_OpenAfsNw関数をご利用ください。

ptid ：パーティションID

flid ：ファイルID

なし

ADXFハンドル、エラーの場合はNULL

ADXFハンドルを作成し、パーティションIDとファイルIDで指定されたAFSファイルのオープンを開始します。

本関数は即時復帰型の関数です。関数内で長時間処理がブロックされることはありません。

本関数はファイルオープンの成否に関係なく、ADXFハンドルを返します。ファイルのオープンに失敗した場合には、ADXFハンドルのステータスがエラー状態に遷移します。

ADXF_OpenNw関数を実行してから実際にファイルがオープンされるまでの間に以下の関数を実行した場合、下記関数内で処理がブロックされます。

・ADXF_GetFsizeSct関数

・ADXF_GetFsizeByte関数

・ADXF_GetFsizeByte64関数

・ADXF_Seek関数

・ADXF_Close関数

これらの関数内で処理がブロックされるのを回避するには、ADXF_IsOpened関数を使用してファイルがオープンされたかどうかを確認する必要があります。

/* ファイルのオープンを開始 */
adxf = ADXF_OpenAfsNw(ptid, flid);


/* ファイルのオープン完了待ち */
for (;;) {
    /* ファイルがオープンされたかどうかチェック */
    bl_ret = ADXF_IsOpened(adxf);
    if (bl_ret != FALSE) {
        break;
    }


    /* エラーチェック */
    stat = ADXF_GetStat(adxf);
    if (stat == ADXF_STAT_ERROR) {
        /* エラー処理 */
        …
    }


    /* サーバ処理 */
    ADXM_ExecMain();
    ADXM_WatiVsync();
}


/* ファイルサイズの取得 */
nsct = ADXF_GetFsizeSct(adxf);
    :

adxf ：ADXFハンドル

なし

TRUE = ファイルがオープンされている、FALSE = ファイルがオープンされていない

ファイルが既にオープンされているかどうかをチェックする。

adxf ：ADXFハンドル

なし

なし

指定されたADXFハンドルをクローズする。

adxf ：ADXFハンドル

nsct ：読み込みデータ量(単位：セクタ)

buf ：読み込み領域

なし

読み込み要求サイズ(単位：セクタ)

データ読み込みのリクエストを発行する。

リクエストしたアクセス動作が完了すると、アクセスポインタはnsctセクタ進む。

bufのアドレス境界はプラットフォーム毎に異なるので注意する必要がある。

ファイル末をまたぐような読み込みセクタ数を指定された時は、ファイル末までのセクタ数を返し、ファイル末までの読み込み処理を行う。

ADXF_ReadNw関数の戻り値は、読み込み要求を行ったサイズです。実際に読み込めるデータ量とは必ずしも一致しません。

実際に読み込めたデータ量を知りたい場合には、リード処理完了後にADXF_GetNumReadSct関数を実行してください。

ADXF_ReadNw関数の戻り値と実際に読み込めたデータ量とが食い違うケースとしては、以下が挙げられます。

・リード処理中にファイルの終端に達した場合

・リード処理中にエラーが発生した場合

・リード処理をADXF_Stop関数で停止した場合

adxf ：ADXFハンドル

なし

中止した時点でのアクセスポインタの位置

データの読み込みを停止する。

adxf ：ADXFハンドル

なし

中止を要求した時点でのアクセスポインタの位置

データ読み込みの停止を要求する。

状態は関数実行直後に変化せず、読み込みが停止した時にSTOP状態に遷移する。

なし

なし

なし

内部状態を更新する。

Vsync割込みで自動的に呼び出されるため、アプリケーション側から呼び出す必要はない。

adxf ：ADXFハンドル

pos ：アクセスポインタ移動量(単位：セクタ)

type ：移動基準(シークタイプ：ADXF_SEEK_~)

なし

アクセスポインタの位置

アクセスポインタをtypeからposセクタ離れた位置に移動させる。

ファイル末尾を越える位置への移動が指定された場合は、ファイルの末尾にアクセスポインタを移動する。

ファイル読み込み中（ADXFハンドルのステータスがADXF_STAT_READINGの状態）に本関数を実行した場合、現在の読み込み処理が途中キャンセルされます。

adxf ：ADXFハンドル

なし

アクセスポインタの位置(単位：セクタ)

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

adxf ：ADXFハンドル

なし

ファイルサイズ(単位：セクタ)

指定されたファイルのサイズをセクタ単位で取得する。

adxf ：ADXFハンドル

なし

ファイルサイズ(単位：バイト)

指定されたファイルのサイズをバイト単位で取得する。

adxf ：ADXFハンドル

seeekpos：読み込み位置

要求した読み込みデータ量(単位：セクタ)

ADXF_ReadNw関数で要求した読み込み位置とデータ量を取得する。

adxf ：ADXFハンドル

なし

読み込んだデータ量(単位：セクタ)

実際に読み込んだデータ量を取得する。

adxf ：ADXFハンドル

なし

ADXFハンドルの内部状態(状態：ADXF_STAT_~)

ADXFハンドルの内部状態を取得する。

adxf ：ADXFハンドル

なし

1=データ読み込み中、0=データ読み込み停止中

データ読み込み状態を取得する。

fname ：ファイル名

なし

ファイルサイズ(単位：バイト)

ファイル名を指定してファイルサイズを取得する。

ディスクアクセスが発生するので、時間がかかる場合がある。

[書 式] Bool ADXF_IsExistFile(const Char8 *fname);

[入 力] fname ：ファイル名

[出 力] なし

[戻り値] TRUE = ファイルが存在する、FALSE = ファイルが存在しない

[説明] 指定されたファイルが存在するかどうか確認する。

[備 考] ファイルが見つからない場合でもエラーコールバックは発生しない

sprmr ：ROFSセットアップ構造体(NULLを指定)

なし

なし

ROFSをセットアップします。

なし

なし

なし

ROFSをシャットダウンします。

volname ：ROFSボリューム名

imgname ：イメージファイル名(CVMファイル)

なし

エラーコード

指定されたイメージファイルをROFSボリュームとして追加します。imgnameには必ずデバイス名を付けてください。

ADXF_AddRofsVol("VOL1", "HST:vol1.cvm");
ADXF_AddRofsVol("VOL2", "HST:vol2.cvm");

volname ：ROFSボリューム名

なし

なし

指定されたROFSボリュームを削除します。

devname ：デバイス名

なし

なし

デフォルトデバイス名を設定します。複数のデバイスが存在する場合に、この関数によりデフォルトのデバイスを切り替えることが可能です。