FILEINFO 関数

構文

FILEINFO ( file.variable ,  key)

file.variable は、開いているファイルのファイル変数です。

key は、必要な特定の情報を示す数値です。 これらのキー番号の説明は、「FILEINFO 関数で用意されているキーおよび数値」の表にあります。

説明

FILEINFO 関数を使用すると、指定したファイルの構成に関する情報 (パラメーター、モジュラスとロード、オペレーティング・システムのファイル名、VOC 名など) を返すことができます。返される情報は、ファイル・タイプとキーの値によって決まります。

最初の引数がファイル変数でなければ、0 を除くすべてのキーは空白ストリングを返します。 警告メッセージも表示されます。 無効なキーを指定すると致命的エラーになります。

キーの等式名

等式名の挿入ファイルは、キー番号ではなくニーモニックを使用できるように用意されています。 挿入ファイルは、FILEINFO.INS.IBAS という名前で UV アカウント・ディレクトリー内の INCLUDE ディレクトリーに格納されています。 このファイルは、PIOPEN フレーバー・アカウントでは SYSCOM という名前の VOC ファイル・ポインターを通して参照されます。$INCLUDE ステートメントは、次の例に示すように等式名を使用する場合にこのファイルを挿入します。 次の表に、シンボル名、数値、および説明を示します。

STATUS 関数によって返される値

関数が正常に実行されると STATUS 関数は 0 を返し、関数が実行に失敗すると STATUS はゼロ以外の値を返します。 次の表に、キー、ファイル・タイプ、および key に対して戻り値を示します。

^{1 分散ファイルに対して返される値は、各パート・ファイルの該当の値を持つ動的な配列です。 各値は、パート・ファイルのファイル・タイプによって決まります。 例えば、パート・ファイルがハッシュ・ファイルなら、最小モジュラスなどの一部の数値はそのパート・ファイルの動的な配列では空ストリングになります。}

NLS モード

FILEINFO 関数は、FINFO$NLSMAP の値に基づいてファイルのマップ名を判定します。 NLS は FILEINFO.H と呼ばれる挿入ファイルを使用します。

例

次の例では、キーの等式名を含むファイルが $INCLUDE ステートメントで挿入されます。 FILMS ファイルが開いてそのファイル・タイプが表示されます。

$INCLUDE SYSCOM FILEINFO.INS.IBAS
OPEN '','FILMS' TO FILMS
        ELSE STOP 'CANT OPEN FILE'
PRINT FILEINFO(FILMS,FINFO$TYPE)

次の例では、FILMS ファイルが開いて、そのファイル・タイプは数値キーを指定することで表示されます。

OPEN '','FILMS' TO FILMS
        ELSE STOP 'CANT OPEN FILE'
PRINT FILEINFO(FILMS,3)