foldersearch

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

foldersearch 機能

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

フォルダがあるか確かめます。

コマンドライン

foldersearch <foldername>

機能説明

フォルダ が存在するかどうか調べます。

チェックする対象としてはフォルダのみとなります。
<foldername> で指定したフォルダが存在する場合は、<result> に 1 が返ります。
<foldername> で指定したフォルダが存在しないまたはファイルが存在する場合は、<result> に 0 が返ります。
<foldername>
フォルダ名を指定します。

指定した名前のファイルが存在する場合は、対象がフォルダではないため 0 (フォルダは存在しない) を返します。
このため、フォルダ作成コマンド foldercreate の実行前チェックとしては不足*1しており、ファイルが存在するかどうかも併せてチェックする必要があります。

パラメータの説明

指定するパラメータは以下の通りです。
パラメータパラメータ説明
<foldername>文字列フォルダ名を指定します。

対象バージョン

バージョン 4.69 以降で利用可能です。

戻り値

戻り値として以下の変数が定義されます。
変数名意味
result0<foldername> で指定したフォルダが存在しない
1<foldername> で指定したフォルダが存在する

関連コマンド

種別:ファイル操作Ver機能の簡易説明
foldercreate4.69以降フォルダを作成する。
folderdelete4.69以降フォルダを削除する。

*1 : 作成しようとうするフォルダ名と同じ名のファイルが存在する場合はエラーとなる。

使用方法

使用例

・フォルダの有無を確認する場合
foldersearch 'data'
if result=0 messagebox 'Folder not found.' 'error'
・フォルダ作成前に同名ファイル/フォルダの有無をチェックする場合
name = 'data'
filesearch name
if result=1 then
    foldersearch name
    if result=1 then
        sprintf2 msg '%s is a folder.' name
        messagebox msg ''
    else
        sprintf2 msg '%s is a file.' name
        messagebox msg ''
    endif
else
    sprintf2 msg '%s is not found.' name
    messagebox msg ''
endif

サンプル

以下のサンプルが存在します。

備考

特にありません。