eDocFinder Help

共通マクロ書式

ファイルシステム書式
フォルダ作成

{%CREATE_FOLDER(フォルダ名)}

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

マクロの戻り値に引数で渡されたフォルダパスを返却します。

例1 「C:\Home\test\abc」フォルダを作成する。

{%CREATE_FOLDER(C:\Home\test\abc)}

例2 「C:\Home\test\abc」フォルダを作成してフォルダパスをログ出力する。

{%WRITE_LOG({%CREATE_FOLDER(C:\Home\test\abc)})}
ファイル存在チェック

{%EXISTS_FILE(ファイル名)}

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

例1 「D:\Test\File01.txt」ファイルの存在チェックを行う。

{%IF({%EXISTS_FILE(D:\Test\File01.txt)}=True,MSGBOX(あり),MSGBOX(なし))}
フォルダ存在チェック

{%EXISTS_FOLDER(フォルダ名)}

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

例1 「D:\Test」フォルダの存在チェックを行う。

{%IF({%EXISTS_FOLDER(D:\Test)}=True,MSGBOX(あり),MSGBOX(なし))}
ファイルコピー

{%COPY_FILE(コピー元ファイル名,コピー先ファイル名[,コピー先ファイル存在時の処理(SeqNo|Overwrite|DoNothing|Error)][,コピー先タイプ指定(File|Folder)])}

ファイルをコピーします。

コピー先のフォルダが存在しない場合は自動で作成します。

コピー元ファイル名が空文字の場合は何も処理を行いません。

コピー先ファイル存在時の処理は、以下の何れかを指定します。省略時はファイル名の末尾に連番を付与します。

SeqNo [既定値]

ファイル名の末尾に連番を付与する。(例 Test.xdw -> Test_0001.xdw)

Overwrite

ファイルを上書きする。

DoNothing

何もしない。

Error

エラーとする。

コピー先タイプ指定は、ファイル名(File)、フォルダ名(Folder)の何れかを指定します。省略するとファイル(File)になります。コピー先のパスにフォルダ名を指定した場合は、コピー先タイプ指定に「Folder」を指定してください。コピー元のファイル名と同じファイル名でコピーを行います。

マクロの戻り値に、コピー先ファイルのフルパスが返却されます。

例1 「D:\Test\File01.txt」ファイルを「D:\Test\控え\File01.txt」にコピーします。(同名のファイルがある場合は連番付与する。)

{%COPY_FILE(D:\Test\File01.txt,D:\Test\控え\File01.txt)}

例2 「D:\Test\File01.txt」ファイルを「D:\Test\控え\File01.txt」にコピーします。(コピー先ファイル名省略)

{%COPY_FILE(D:\Test\File01.txt,D:\Test\控え,,Folder)}

例3 「D:\Test\File01.txt」ファイルを「D:\Test\控え\File01.txt」にコピーします。(同名のファイルがある場合は上書きする。)

{%COPY_FILE(D:\Test\File01.txt,D:\Test\控え\File01.txt,Overwrite)}
ファイル移動

{%MOVE_FILE(移動元ファイル名,移動先ファイル名[,移動先ファイル存在時の処理(SeqNo|Overwrite|DoNothing|Error)][,移動先タイプ指定(File|Folder)][,移動方式(CopyDelete|Move)])}

ファイルを移動します。

移動先のフォルダが存在しない場合は自動で作成します。

移動元ファイル名が空文字の場合は何も処理を行いません。

移動先ファイル存在時の処理は、以下の何れかを指定します。省略時はファイル名の末尾に連番を付与します。

SeqNo [既定値]

ファイル名の末尾に連番を付与する。(例 Test.xdw -> Test_0001.xdw)

Overwrite

ファイルを上書きする。

DoNothing

何もしない。

Error

エラーとする。

移動先タイプ指定は、ファイル名(File)、フォルダ名(Folder)の何れかを指定します。省略するとファイル(File)になります。移動先のパスにフォルダ名を指定した場合は、移動先タイプ指定に「Folder」を指定してください。移動元のファイル名と同じファイル名で移動を行います。

移動方式にファイル移動(Move)を指定した場合は、通常のファイル移動APIを使用します。省略するとファイルコピー後削除(CopyDelete)になり、ファイルコピーを行った後に、コピー元ファイルを削除する方式でファイル移動を行います。

ファイルシステムのAPIでは、同一ドライブのファイル移動はパスの付け替えだけを行っているので、ファイルの権限が移動元の状態のまま変化しません。ですが、コピーの場合はコピー先フォルダの権限を継承します。

マクロの戻り値に、移動先ファイルのフルパスが返却されます。

例1 「D:\Test\File01.txt」ファイルを「D:\Test\処理済み\File01.txt」に移動します。(同名のファイルがある場合は連番付与する。)

{%MOVE_FILE(D:\Test\File01.txt,D:\Test\処理済み\File01.txt)}

例2 「D:\Test\File01.txt」ファイルを「D:\Test\処理済み\File01.txt」に移動します。(移動先ファイル名省略)

{%MOVE_FILE(D:\Test\File01.txt,D:\Test\処理済み,,Folder)}

例3 「D:\Test\File01.txt」ファイルを「D:\Test\処理済み\File01.txt」に移動します。(同名のファイルがある場合は上書きする。)

{%MOVE_FILE(D:\Test\File01.txt,D:\Test\処理済み\File01.txt,Overwrite)}
連番ファイル名取得

{%GET_SEQUENCE_FILENAME(ファイル名)}

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

例1 「D:\Test\File01.txt」の存在チェックを行い、存在する場合は末尾に連番を付与したファイル名を取得する。存在しない場合は、引数のファイル名を返却する。

{%GET_SEQUENCE_FILENAME(D:\Test\File01.txt)}
結果 ファイルが存在する場合
D:\Test\File01_0001.txt