findfirst

【Tera Term マクロ言語】コマンドリファレンス

findfirst 機能

[ファイル操作コマンド]

文字列に合致する最初のファイルを探します。

コマンドライン

findfirst <dir handle> <file name> <strvar>

機能説明

findfirst コマンドはファイル名 <file name> に合致する最初のファイルを探します。

ファイルが見つかった場合、ディレクトリハンドルが <dir handle> に、最初のファイル名が <strvar> に格納され、システム変数 <result> に 1 が格納されます。
<dir handle>
ファイルが見つかった場合、そのファイルパスのディレクトリが、ディレクトリハンドル <dir handle> 格納されます。
<file name>
探したいファイル名を指定します。
<strvar>
ファイルが見つかった場合、最初のファイル名が <strvar> に格納されます。

findfirst コマンドが最初のファイルを見つけた場合、ディレクトリハンドルを指定して findnext コマンドを使用し、 <file name> に合致する次のファイルを探すことができます。

ディレクトリハンドルは findclose コマンドによって解放されなければなりません。

パラメータの説明

指定するパラメータは以下の通りです。
パラメータパラメータ説明
<dir handle>整数ディレクトリハンドルを指定します。
<file name>文字列対象とするファイル名を指定します。
<strvar>文字列最初に見つけたファイル名を格納する変数を指定します。

対象バージョン

全てのバージョンで利用可能です。

戻り値

戻り値として以下の変数が定義されます。
変数名意味
result0ファイルが見つけられなかった
1ファイルが見つかった
<strvar>文字列見つけたファイル名
<strvar> は、コマンド実行時に指定した任意の文字列です。

関連コマンド

種別:ファイル操作Ver機能の簡易説明
0176文字列に合致する次のファイルを探す。
0177ディレクトリハンドルを解放する。

使用方法

使用例

・ファイル名を検索する場合
extpat='*.txt'
findfirst dh extpat filename

while result
	messagebox filename extpat
	findnext dh filename
endwhile

findclose dh

サンプル

サンプルマクロはありません。

備考

特にありません。