7.関数仕様-3

7.3　ストリーム

一 覧 表

Title 関数仕様

Function ファイル識別子によるストリーム のオープン

Function Name STM_OpenFid

No 3.1

　書　式

StmHn STM_OpenFid(StmGrpHn grp, Sint32 fid, StmKey *key,Sint32 lpread)

　入　力

grp	：ストリームグループハンドル
fid	：ファイル識別子
key	：ストリームキー
lpread	：ループ再生時の再読み込み指定 (StmLoopRead)

　出　力

なし

　関数値

ストリームハンドル(エラーの場合NULL)

　機　能

ファイル識別子によりストリームをオープンし、指定したストリームグループに登録します。

　備　考

ストリームキーのファイル番号は、使用しません。

一 覧 表

Title 関数仕様

Function 再生範囲によるストリームのオープン

Function Name STM_OpenFrange

No 3.2

　書　式

StmHn STM_OpenFrange(StmGrpHn grp, StmFrange *frange, StmKey *key, Sint32 lpread)

　入　力

grp	：ストリームグループハンドル
frange	：再生範囲
key	：ストリームキー
lpread	：ループ再生時の再読み込み指定 (StmLoopRead)

　出　力

なし

　関数値

ストリームハンドル(エラーの場合NULL)

　機　能

再生範囲によりストリームをオープンし、ストリームグループに登録します。

一 覧 表

Title 関数仕様

Function 常駐ストリームのオープン

Function Name STM_OpenResi

No 3.3

　書　式

StmHn STM_OpenResi(StmGrpHn grp,Sint32 fid,StmKey *key,Sint32 fad)

　入　力

grp	：ストリームハンドル
fid	：ファイル識別子
key	：ストリームキー
fad	：転送開始FAD

　出　力

なし

　関数値

ストリームハンドル(エラーの場合NULL)

　機　能

常駐ストリームをオープンします。

　備　考

SIMM, SCSI上のファイルは、常駐ストリームとしてのみ利用可能です。

一 覧 表

Title 関数仕様

Function ストリームのクローズ

Function Name STM_Close

No 3.4

　書　式

void STM_Close(StmHn stm)

　入　力

stm　:ストリームハンドル

　出　力

なし

　関数値

なし

　機　能

指定したストリームをクローズします。

　備　考

転送関数が登録されている場合、前回呼び出したときの関数値が(-1)であれば、転送関数が0以上の値を返すまでストリームシステムは転送関数を呼び続けます。

一 覧 表

Title 関数仕様

Function ストリームキーの設定

Function Name STM_SetKey

No 3.5

　書　式

void STM_SetKey(StmHn stm, StmKey *stmkey)

　入　力

stm	：ストリームハンドル
stmkey	：ストリームキー

　出　力

なし

　関数値

なし

　機　能

指定したストリームにストリームキーを設定します。

一 覧 表

Title 関数仕様

Function ストリーム情報の取得

Function Name STM_GetInfo

No 3.6

　書　式

StmGrpHn STM_GetInfo(StmHn stm, Sint32 *fid, StmFrange *frange,Sint32 *bn, StmKey *stmkey)

　入　力

stm：ストリームハンドル

　出　力

fid	：ファイル識別子(再生範囲によりオープンした場合(-1))
frange	：再生範囲
bn	：バッファ区画番号
stmkey	：ストリームキー

　関数値

所属するストリームグループ

　機　能

指定したストリームの情報を取得します。

一 覧 表

Title 関数仕様

Function セクタ数からワード数への変換

Function Name STM_SctToWord

No 3.7

　書　式

Sint32 STM_SctToWord(StmHn stm, Sint32 nsct)

　入　力

stm	：ストリームハンドル
nsct	：セクタ数

　出　力

なし

　関数値

指定したセクタ数に対応するワード数。エラーの場合、エラーコード。

　機　能

CDバッファ区画に読み込まれているデータの先頭から、指定セクタ分のワード数を取得します。

　備　考

1. 読み込まれているセクタ数よりも大きい値が指定された場合、読み込まれているデータのワード数が返ります。

2. フォーム１，２が混在している場合にも有効です。

一 覧 表

Title 関数仕様

Function ワード数からセクタ数への変換

Function Name STM_WordToSct

No 3.8

　書　式

Sint32 STM_WordToSct(StmHn stm, Sint32 nword)

　入　力

stm	：ストリームハンドル
nword	：ワード数

　出　力

なし

　関数値

指定されたワード数に対応するセクタ数。エラーの場合、エラーコード。

　機　能

CDバッファ区画に読み込まれているデータの先頭から、指定ワード分のセクタ数を取得します。

　備　考

1. 読み込まれているデータのワード数よりも大きい値が指定された場合、読み込まれているセクタ数が返ります。

2. フォーム１，２が混在している場合にも有効です。

一 覧 表

Title 関数仕様

Function ストリームハンドルのエイリアス設定

Function Name STM_SetAlias

No 3.9

　書　式

Bool STM_SetAlias(StmHn alias, StmHn stm)

　入　力

alias	：別名のストリームハンドル
stm	：アクセスするストリームハンドル

　出　力

なし

　関数値

TRUE	：エイリアスが設定できた
FALSE	：エイリアスが設定できなかった

　機　能

ストリームハンドルstmに対し別名aliasをつけます。

　備　考

1. aliasを使用して、stmで指定されるストリームを操作できるようにします。

2. alias, stmともにオープン済みのストリームを指定してください。

3. 別名を解除するには、STM_UnsetAliasを使用します。

一 覧 表

Title 関数仕様

Function ストリームハンドルのエイリアス解除

Function Name STM_UnsetAlias

No 3.10

　書　式

void STM_UnsetAlias(StmHn alias)

　入　力

alias：別名のストリームハンドル

　出　力

なし

　関数値

なし
ストリームに設定されている別名を解除します。

　備　考

STM_SetAliasで設定した別名を解除するための関数です。