GetFolderExpandState関数(TKInfo.dll)(Ver7.33対応版)
この関数は、パラメータで指定されたフォルダの配下にさらにフォルダがあるかどうか、ある場合はそれが折り畳まれているか、それとも展開されているかを返します。
- パラメータ1(文字列型)
-
対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。
- パラメータ2(文字列型)
-
対象のメール用のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
パラメータ1とパラメータ2の両方に""を指定するか、またはパラメータ1、パラメータ2両方ともを省略すると、現在選択しているフォルダという意味になります。
- 返り値(数値型)
-
現在選択されているフォルダ(アカウントの場合も含む)の配下に子となるフォルダがある場合で、
折り畳まれている場合、0
展開されている場合、1
を返します。
配下に子となるフォルダ類が無い場合は2を返します。
パラメータで指定されたフォルダ(またはアカウント自体)が存在しない場合は、-1を返します。
- 注意事項
-
アカウント直下にユーザーが作成されたフォルダは、秀丸メール内部では、アカウント直下ではなく、アカウント直下の「User」というフォルダの配下に存在しているような扱いとなっています。マクロ上でもそれがそのまま適用されます。
例えばアカウント直下に「ABC」というフォルダがある場合、CurrentFolder関数の返す値は「User\ABC」となります。他、フォルダを扱う関数では、すべて「User」が間に入ってくることにご注意ください。
例 |
#n = dllfunc( "GetFolderExpandState");
#n = dllfunc( "GetFolderExpandState", "", "受信");
#n = dllfunc( "GetFolderExpandState", "テストアカウント", "受信\\テスト");
|