eDocFinder Help

共通マクロ書式

処理中ファイル書式

処理中ファイル書式は、現在処理中のファイルに関する情報を取得します。eDocFinderでは、プラグインから実行された場合に、選択したファイルのフルパスリストがユーザーデータにセットされます。

eDocFinder.exeを直接起動した初期状態は、ファイルリストが空になっています。ファイルリストが空の場合は、ユーザーデータには何もセットされません。

入力フルパスファイル名取得

{%GET_U(InputFile,ファイル番号)}

プラグインから実行された場合、選択されたファイルのフルパスリストがユーザーデータにセットされます。

1番目のキーには「InputFile」を指定します。2番目のキーには1から始まる番号を指定します。

DocuWorksDeskで複数のファイルを選択してプラグインを呼び出した場合は、複数のフルパスがセットされます。

フルパスリストの個数は、「{%GET_USER_DATA_KEY_COUNT(InputFile)}」で取得できます。

例1 処理中ファイルのフルパスをログに出力します。以下の例ではDocuWorks Deskで「C:\Test\sample01.xdw」を選択して、eDocFinderプラグインを実行した場合、「C:\Test\sample01.xdw」が出力されます。

{%WRITE_LOG({%GET_U(InputFile,1)})}

例2 処理中ファイルの全てのフルパスをログに出力します。以下の例ではDocuWorks Deskで「C:\Test\sample01.xdw」、「C:\Test\sample02.xdw」を選択して、eDocFinderプラグインを実行した場合、「C:\Test\sample01.xdw」、「C:\Test\sample02.xdw」が出力されます。

{%LOOP L1 {%GET_USER_DATA_KEY_COUNT(InputFile)}(
  {%WRITE_LOG({%GET_U(InputFile,[L_IDX(L1)])})}
)}
入力ファイルリストクリア

{%CLEAR_INPUT_FILE_LIST()}

メイン画面のファイルリストをクリアします。

本マクロは処理の実行がすべて終了したタイミングで実行されます。

処理中にエラーが発生した場合はファイルリストをクリアしません。

例1 メイン画面のファイルリストをクリアします。

{%CLEAR_INPUT_FILENAME_LIST()}
ファイルの繰り返しの中で使用できるマクロ

以下はファイルの繰り返し処理で対象となっているファイルの情報となります。

ファイル名取得

{%GET(FileName)}

処理中のファイル名を取得します。

例1 処理中のファイル名を取得します。以下の例では、「C:\Test\sample01.txt」を処理している場合、「sample01.txt」が表示されます。

{%MSGBOX({%GET(FileName)})}
フォルダパス取得

{%GET(FolderPath)}

処理中ファイルのフルパスフォルダ名を取得します。

例1 処理中のフルパスフォルダ名を取得します。以下の例では、「C:\Test\sample01.txt」を処理している場合、「C:\Test」が表示されます。

{%MSGBOX({%GET(FolderPath)})}
フォルダ名取得

{%GET(FolderName[,階層番号])}

処理中ファイルのフォルダ名を取得します。

階層番号にフォルダパスの右から何番目の要素を指定することができます。例えばフォルダパスが「C:\a\b\c」の場合、2と指定すると「b」が返却されます。

例1 処理中のファイルのカレントフォルダ名を取得します。以下の例では、「C:\Test\sample01.txt」を処理している場合、「Test」が表示されます。

{%MSGBOX({%GET(FolderName)})}

例2 処理中のファイルのカレントフォルダの上のフォルダ名を取得します。以下の例では、「C:\見積書\伊藤\連番付与\sample01.txt」を処理している場合、「伊藤」が表示されます。

{%MSGBOX({%GET(FolderName,2)})}
フルパスファイル名取得

{%GET(FullPathFileName)}

処理中ファイルのフルパスファイル名を取得します。

例1 処理中のフルパスファイル名を取得します。以下の例では、「C:\Test\sample01.txt」を処理している場合、「C:\Test\sample01.txt」が表示されます。

{%MSGBOX({%GET(FullPathFileName)})}
拡張子を除いたファイル名取得

{%GET(FileNameWithoutExtension)}

処理中ファイルの拡張子を除いたファイル名を取得します。

例1 処理中のファイルの拡張子を除いたファイル名を取得します。以下の例では、「C:\Test\sample01.txt」を処理している場合、「sample01」が表示されます。

{%MSGBOX({%GET(FileNameWithoutExtension)})}