NAME メッセージボックス表示

FORMAT {%MSGBOX(メッセージ)}

引数のメッセージをダイアログに表示します。

NAME エラー出力

FORMAT {%ERROR_RAISE(エラーメッセージ)}

エラーを発生させます。通常のエラーと同様に、処理中の処理を中断し、次の処理を行います。引数にエラーメッセージを指定することができます。
IFマクロと併用し、条件によりエラーを発生させて使います。

NAME ログ出力

FORMAT {%LOG_OUT(メッセージ)}

eDocArrangementの処理結果にメッセージを出力します。ログ設定が有効になっていれば、通常のログと一緒に出力されます。

NAME ファイル削除

FORMAT {%DELETE_FILE(ファイル名)}

ファイル名に指定されたファイルを削除します。ファイルが存在しない場合は何もしません。
ファイルの削除に成功した場合は、ファイル名を返却します。
ファイルが存在しない場合は、空文字を返却します。

NAME フォルダ削除

FORMAT {%DELETE_FOLDER(フォルダ名)}

フォルダ名に指定されたフォルダを削除します。フォルダが存在しない場合は何もしません。
フォルダの中が空の場合のみ削除します。
フォルダの削除に成功した場合は、フォルダ名を返却します。
フォルダが存在しない場合は、空文字を返却します。
フォルダの中にファイル又はフォルダが存在する場合はエラーとなります。

NAME フォルダ作成

FORMAT {%CREATE_FOLDER(フォルダ名)}

フォルダ名に指定されたフォルダを作成します。上位から順番に存在しないフォルダを作成していきますので、パスで指定された全てのフォルダを一度に作成できます。

NAME ファイル存在チェック

FORMAT {%EXISTS_FILE(ファイル名)}

ファイル名に指定されたファイルが存在するかチェックします。ファイルが存在する場合はTrueを返却し、存在しない場合はFalseを返却します。

NAME フォルダ存在チェック

FORMAT {%EXISTS_FOLDER(フォルダ名)}

フォルダ名に指定されたフォルダが存在するかチェックします。フォルダが存在する場合はTrueを返却し、存在しない場合はFalseを返却します。

NAME ファイルコピー

FORMAT {%COPY_FILE(コピー元ファイル名,コピー先ファイル名)}

ファイルをコピーします。コピー先に既に同名のファイルが存在する場合は、エラーが発生します。

NAME 複数ファイルコピー

FORMAT {%MULTI_COPY_FILE(コピー元ファイル名,コピー先ファイル名,回数)}

ファイルを回数で指定された数分コピー（複製）します。コピー先ファイル名には[No]という文字を含ませてください。実行時に[No]が番号に置換されます。

コピー先に既に同名のファイルが存在する場合は、エラーが発生します。

NAME ファイル移動

FORMAT {%MOVE_FILE(移動元ファイル名,移動先ファイル名)}

ファイルを移動します。移動先に既に同名のファイルが存在する場合は、エラーが発生します。

NAME 空フォルダチェック

FORMAT {%IS_FOLDER_EMPTY(フォルダ名)}

フォルダ名に指定されたフォルダ内にファイル又は、フォルダが存在するかチェックします。存在しない場合はTrueを返却し、存在する場合はFalseを返却します。

NAME 連番ファイル名取得

FORMAT {%GET_SEQUENCE_FILENAME(ファイル名)}

ファイル名に指定されたファイルが存在するかチェックし、ファイルが存在する場合はファイル名の末尾に連番を付与したファイル名を返却します。

NAME ファイル・フォルダの作成日時取得

FORMAT {%GET_CREATION_TIME(ファイル名、又は、フォルダ名)}

指定されたファイル、又は、フォルダの作成日時を取得します。取得される形式は、「yyyyy/mm/dd hh:nn:ss」です。

NAME ファイル・フォルダの更新日時取得

FORMAT {%GET_LAST_WRITE_TIME(ファイル名、又は、フォルダ名)}

指定されたファイル、又は、フォルダの更新日時を取得します。取得される形式は、「yyyyy/mm/dd hh:nn:ss」です。

NAME ファイル・フォルダのアクセス日時取得

FORMAT {%GET_LAST_ACCESS_TIME(ファイル名、又は、フォルダ名)}

指定されたファイル、又は、フォルダのアクセス日時を取得します。取得される形式は、「yyyyy/mm/dd hh:nn:ss」です。

NAME ファイル読み込み

FORMAT {%FILE_READ(ファイル名,ユーザデータ名)}

ファイル名に指定されたテキストファイルを行単位で読み込みます。読み込んだテキストデータは、ユーザデータに格納します。
読み取った内容はユーザデータのキーに行番号(1〜)を指定することで参照できます。
また、読み取り行数は、キーに「Count」を指定することで参照できます。

NAME CSVファイル読み込み

FORMAT {%CSV_FILE_READ(ファイル名,ユーザデータ名,キー番号)}

ファイル名に指定されたCSVファイルを読み込みます。読み込んだ項目は、ユーザデータに格納します。

分割されるデータにユニークキーがある場合は、引数のキー番号にユニークキーの項目番号(1〜n)を指定します。ユニークキーがない場合は引数のキー番号に0を指定します。

結果として格納されるユーザデータは、「引数で指定した出力ユーザデータ名 + "_" + ユニークキー」という名前で設定します。 したがって、データの件数分、ユーザデータが作成されることになります。

分割されたデータにユニークキーとして指定した項目が存在しない場合、又は0を指定した場合は、ユーザデータ名の末尾に付加する文字を行番号にします。 （「引数で指定した出力ユーザデータ + "_" + 行番号」）

ユニークであるはずのキーが複数存在した場合には、後から読み込んだデータ(キー)で上書きします。

ユーザデータの中身は、項目番号をキーとして、項目の内容を値としてセットします。

また、読み取り行数はキーに「Count」を指定することで参照できます。読み取り項目数はGET_USER_DATA_COUNTマクロで取得できます。

このマクロはExcelで保存可能な、項目に改行が入ったCSV(項目の前後が""で囲われている書式)も読み込めます。

NAME ファイル読み込みとマクロ実行

FORMAT {%FILE_READ_AND_MACRO_EXECUTE(ファイル名,ユーザデータ名,グローバルデータ名)}

ファイル名に指定されたテキストファイルを行単位で読み込みます。1行読むたびに引数のグローバルデータで定義されたマクロを実行します。あらかじめグローバルデータで実行するマクロを定義しておく必要があります。

読み取った行の内容は引数のユーザデータとキー「1」を指定することで参照できます。1行毎に毎回、キー「1」にセットしますので、使用するメモリは1行分のデータだけとなります。
また、読み取り行数は、キーに「Count」を指定することで参照できます。

但し、eDocArrangementのマクロ実行は処理速度が遅いので、行数の多いテキストファイルに対して処理を行うことはお勧めできません。実測して実用的なケースでご利用ください。

NAME ファイル書き込み

FORMAT {%FILE_WRITE(ファイル名,ユーザデータ名,モード)}

引数に指定されたユーザデータの内容を、テキストファイルに書き込みます。ユーザデータは一つのキーが1行になり、ファイルには値が出力されます。出力順は、ユーザデータの登録順になります。

モードには、「OUTPUT」または「APPEND」を指定します。「OUTPUT」の場合、ファイルが既に存在した場合に上書きになります。「APPEND」は追加書き込みになります。ファイルが存在しない場合は、両方共に新しく作成します。

NAME ファイル検索(フォルダ検索)

FORMAT {%SEARCH_FILE(フォルダ名,ファイル名,データ名,サブフォルダ検索指定[,フォルダ検索指定][,検索結果の形式])}

指定のフォルダからファイル又は、フォルダを検索します。

フォルダ名には、検索するフォルダを指定します。

ファイル名に検索したいファイルを指定します。ファイル名にはワイルドカードが使用できます。;(セミコロン)で区切ることによって複数指定が可能です。

データ名には、検索結果を保存するユーザデータのデータ名を指定します。

サブフォルダ検索指定には、「SUB_DIR」又は「CURRENT_DIR」を指定します。「SUB_DIR」を指定するとサブディレクトリも検索の対象となります。「CURRENT_DIR」を指定すると指定したフォルダのみを検索対象とします。

フォルダ検索指定には、「FOLDER」又は「FILE」を指定します。「FOLDER」を指定すると検索対象がファイルではなくフォルダのみとなります。省略すると「FOLDER」となります。

検索結果の形式には、「FULL」又は「NAME」を指定します。「FULL」を指定すると検索結果がフルパスで格納されます。「NAME」を指定すると検索結果が名前のみで格納されます。省略すると「FULL」となります。

検索結果は指定したデータ名のユーザデータに格納されます。1から始まる連番がキーとなり、値にはフルパスファイル(フォルダ)名か、ファイル(フォルダ)名がセットされます。

NAME ファイル検索移動(キュー方式)

FORMAT {%MOVE_FILE_USING_QUEUE(検索フォルダ名,ファイル名,移動先フォルダ名,一時フォルダ名[,ソート対象][,並び順])}

指定のフォルダからファイルを検索し、最初に見つかったファイルを移動先フォルダに移動します。本マクロは、指定フォルダ内のファイルをキュー(待ち行列)方式で移動することを目的としています。処理は排他制御され、複数の端末から同時に本マクロを実行しても、同じファイルが2つのフォルダに移動(複製)されることはありません。

排他制御を行う為に、「.lock」というフォルダが一時フォルダに作成されます。処理が終了すると、「.lock」フォルダは削除されます。一時フォルダには、複数のPCから参照可能な共有フォルダを指定します。

検索フォルダ名には、検索するフォルダを指定します。共有フォルダを指定してください。

ファイル名に検索したいファイルを指定します。ファイル名にはワイルドカードが使用できます。;(セミコロン)で区切ることによって複数指定が可能です。

一時フォルダ名には、排他制御用のファイルを作成するフォルダを指定します。共有フォルダを指定してください。

移動先フォルダ名には、ファイルの移動先フォルダ名を指定します。ローカルフォルダを指定してください。

ソート対象には、「FILE」又は「DATE」を指定します。「FILE」が指定された場合、ファイル名でソートします。「DATE」が指定された場合、ファイルの更新日付でソートします。省略された場合は、ソートを行いません。

並び順には、「ASC」又は「DESC」を指定します。「ASC」が指定された場合、昇順でソートします。「DESC」が指定された場合、降順でソートします。

ファイルが移動出来た場合は、移動先ファイルのフルパスが返却されます。検索した結果ファイルが見つからない場合は、「ファイルが見つかりません。」が返却されます。他の処理が実行中の場合は「.lock」ファイルが存在するため、処理待ちになりますが、3秒間の間に数回リトライしてタイムアウトとなります。その場合は、「タイムアウトが発生しました。」を返却します。

NAME クリップボード設定

FORMAT {%SET_CLIPBOARD_TEXT(文字列)}

文字列をクリップボードに記憶します。

NAME クリップボード取得

FORMAT {%GET_CLIPBOARD_TEXT}

クリップボードに記憶された文字列を取得します。

NAME 入力ボックス表示

FORMAT {%INPUTBOX(メッセージ,初期値,X座標,Y座標)}

引数のメッセージを入力ダイアログに表示し、入力された文字を返却します。X,Y座標は省略できます。省略した場合は画面中央付近に表示されます。

キャンセルが押された場合は空文字が返却されます。

NAME QRコード画像作成

FORMAT {%CREATE_QR_BITMAP(画像ファイルのパス,内容,セルサイズ,誤り訂正レベル(L|M|Q|H),余白サイズ[,解像度])}

引数の内容に従ってQRコードを作成し、ビットマップ画像として保存します。

セルサイズは出力するQRコードの1ドットを表すピクセル数の指定になります。
誤り訂正レベルは、L,M,Q,Hの何れかを指定します。記号の意味は、それぞれ、L(7%),M(15%),Q(25%),H(30%)になります。
余白サイズはQRコードの周りの余白のピクセル数です。
解像度は省略可能です。縮小帳票などでQRコードを小さく印字したい場合は96以上の値を指定することで小さくできます。既定値は96です。

NAME メール送信

FORMAT {%SEND_MAIL(データ名(宛先),送信元メールアドレス,データ名(CC),データ名(BCC),件名,本文[,データ名(ファイル)][,データ名(オプション)])}

SMTPサーバの情報は、設定の基本設定で、「処理結果のメール通知、又は、SMTPサーバの設定を行う」にチェックを入れ、メール設定からサーバの情報を入力します。SMTPサーバの設定が行われていない場合はメール送信ができません。メール送信マクロを使用する場合は、必ず設定してください。

引数の説明は以下の通りです。

マクロの戻り値は、正常時に「Ture」が返却されます。エラー時は、メールオプションの「CATCH_ERR」が指定されている場合は、「False」が返却されます。設定されていない場合は処理がメール送信マクロが中断されエラーになります。(Falseは返却されません。)

NAME 画像情報取得

FORMAT {%GET_IMAGE_INFORMATION(画像ファイル名)}

引き数で指定した画像ファイルの解像度、縦幅、横幅を取得します。取得できる情報は以下の通りで、結果は「ImageInformation」という名前のユーザデータに格納されます。

BMP,Tiff,JPEG等の画像ファイルに対応しています。マルチページTiffは1ページ目の画像情報を取得します。

NAME スリープ(一定時間待つ)

FORMAT {%SLEEP(ミリ秒)}

引き数で指定した時間(単位はミリ秒)だけ待ちます。

NAME 文字検索結果抽出

FORMAT {%EXTRACT_FOUND_DATA(検索対象文字列,ユーザーデータ,項目位置,結果格納用ユーザーデータ)}

検索対象文字列からユーザーデータの項目位置の文字列を検索し、見つかった場合は、結果格納用ユーザーデータに行番号をセットします。

このマクロは、マスタファイル(CSV)にある製品コード全てを、ページ内テキストから検索して、見つかった製品コードだけをリストにするような場合に使用します。

引数のユーザーデータ、項目位置は、 CSVファイル読み込みマクロで、キー指定を行わない読み込みを行った結果のユーザーデータを対象にしています。(ユーザーデータは、「引数で指定されたユーザーデータ名 + "_" + 行番号」である想定)

結果格納用のユーザーデータには、見つかった行が値に、1〜の連番かキーにセットされます。

NAME 制御コード除去

FORMAT {%REMOVE_CONTROL_CHAR(入力ファイル名,出力ファイル名)}

入力ファイル名に指定したテキストファイルから、制御コードを除去し、出力ファイル名に指定したファイルに出力します。

処理可能なテキストファイルの文字コードはSJISのみです。除去の対象となる文字コードは16進コードで00〜1F,7Fです。但し、改行(0A)、タブ(09)、復帰(0D)は除去しません。

出力ファイルをネットワークフォルダに指定すると、処理速度が遅くなりますので、ローカルフォルダに出力するようにしてください。

NAME ファイルループ中断

FORMAT {%STOP_FILE_LOOP()}

ファイルループを中断します。このマクロを実行すると、次のファイルは処理されず、ファイルループを中断します。

NAME コマンド実行

FORMAT {%COMMAND(コマンド)}

コマンドを実行します。戻り値に実行したコマンドのリターンコードが返ります。

実行したコマンドが終了するまで待機します。コマンドが終了しない場合は永久に待機してしまいますので、そうなった場合はタスクマネージャーでeDocArrangementを強制終了して下さい。