コマンド一覧

秀丸メール本体関係

• 秀丸メール本体関係
  • IsHidemaruMail関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • IsHidemaruMailMain, IsHidemaruMailGrep関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
    • 注：
  • MainWnd関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • SetMainWndTop関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • SelectPane関数（TKInfo.dll）
    • パラメータ１
    • 返り値（数値型）
    • 例
  • CurrentPane関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • HidemaruMailVersion関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • ClearAllUnread関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • RemakeList関数（TKInfo.dll）
    • パラメータ１（文字列型）
    • パラメータ２（文字列型）
    • 返り値（数値型）
    • 例
  • OpenedEditorWnd関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • IsPasswordProtected関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • SetHotIcon関数（TKInfo.dll）
    • パラメータ１（数値型）
    • 返り値（数値型）
    • 例
  • RefreshFolder関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • GetFolderIcon, SetFolderIcon関数（TKInfo.dll）
    • 返り値（数値型）
    • 例

---

IsHidemaruMail関数（TKInfo.dll）

　この関数は、現在のマクロが実行されているのが秀丸メールの中か、それとも秀丸エディタの中なのかを返します。ちなみに、秀丸エディタ上で実行される場合には、loaddll "tkinfo.dll"の段階でエラーになる場合もありえます。

　秀丸メールからテキストファイルを処理したい場合、秀丸エディタと連携して処理する必要があります。そういうときで、マクロを２つに分けたくない場合には、このIsHidemaruMail関数を使って秀丸エディタの時と秀丸メールの時とで処理を分けることができます。

注意：この関数は、ソフトウェア名称の変更に伴って関数名が変更されています。ただし、昔の関数（IsTuruKame関数）もそのまま使えます。

返り値（数値型）

　秀丸メール内部の時は１、そうでないときは０を返します。

例

loaddll "tkinfo.dll";
    if( ! result ) goto HidemaruProcess;
    if( ! dllfunc( "IsHidemaruMail" ) ) goto HidemaruProcess;
    ... 秀丸メールの場合の処理 ...
    endmacro;
HidemaruProcess:
    ... 秀丸エディタの場合の処理 ...

---

IsHidemaruMailMain, IsHidemaruMailGrep関数（TKInfo.dll）

　IsHidemaruMailMain関数は、現在のマクロが秀丸メール本体ウィンドウ上で実行されているのか、そうでないのか（メールエディタ・ウィンドウ上で実行されているのか）を返します。

　IsHidemaruMailGrep関数は、現在のマクロが秀丸メールの検索結果ウィンドウ中のメール内容部分で実行されてるかどうかを返します。検索結果ウィンドウ上で間違って実行されてるかどうかのチェック用に使ってください。

　IsHidemaruMailGrep関数は、リモートメールダイアログボックス中のエディタ内の時も1を返します。

注意：この関数は、ソフトウェア名称の変更に伴って関数名が変更されています。ただし、昔の関数（IsTuruKameMain関数等）もそのまま使えます。

返り値（数値型）

　IsHidemaruMailMain関数は、秀丸メール本体ウィンドウ上の場合は１、そうでない場合は０を返します。
　IsHidemaruMailGrep関数は、検索結果の一覧上またはリモートメールダイアログボックス中の場合は１、そうでない場合は０を返します。

例

（現在のメールの未読/既読切り替えする場合）
if( dllfunc( "IsHidemaruMailMain") ) {
    #n = dllfunc( "SwitchUnread" );
} else {
    #n = dllfunc( "Sync" );
    #current = hidemaruhandle( 0 );
    #n = dllfunc( "SetMainWndTop" );
    #n = dllfunc( "SwitchUnread" );
    setactivehidemaru #current;
}

注：

　IsHidemaruMailMain関数は、秀丸メールV2.32から、検索結果のウィンドウ上である場合は0を返すようになりました。

---

MainWnd関数（TKInfo.dll）

　この関数は、秀丸メール本体ウィンドウのウィンドウハンドルを返します。ウィンドウが存在しない時（メールエディタだけ起動している時）は0を返します。

返り値（数値型）

　秀丸メール本体ウィンドウのウィンドウハンドルです。

例

#main = dllfunc( "MainWnd" );
setactivehidemaru #main;

---

SetMainWndTop関数（TKInfo.dll）

　この関数は、秀丸メール本体ウィンドウを強制的に表に出し、アクティブな状態にします。マクロの実行も秀丸メール本体ウィンドウに移動します。
　秀丸メール本体ウィンドウが存在しない時は失敗して０を返します。

返り値（数値型）

　成功すると１、失敗すると０を返します。

例

#n = dllfunc( "SetMainWndTop" );

---

SelectPane関数（TKInfo.dll）

　この関数は、秀丸メール本体ウィンドウ中の、アクティブな枠を切り替えます。秀丸メール本体ウィンドウ上でのみ実行できます。

パラメータ１

　０の場合はフォルダ枠、１の場合はメール一覧枠、２の場合はメール内容枠がアクティブになります。

返り値（数値型）

　成功すると１、失敗すると（例えば、２枠区切りの時にメール内容枠をアクティブにしようとすると）０を返します。

例

#n = dllfunc( "SelectPane", 0);

---

CurrentPane関数（TKInfo.dll）

　この関数は、秀丸メール本体ウィンドウ中の、現在のアクティブな枠の番号を返します。

返り値（数値型）

　フォルダ枠がアクティブな時は０、メール一覧枠の時は１、メール内容枠の時は２、添付ファイル枠の時は３を返します。

例

#pane = dllfunc( "CurrentPane");

---

HidemaruMailVersion関数（TKInfo.dll）

　この関数は、秀丸メールのバージョン番号を返します。1.00の時は100、0.58の時は58のように、１００倍した値を返します。

注意：この関数は、ソフトウェア名称の変更に伴って関数名が変更されています。ただし、昔の関数（TuruKameVersion関数）もそのまま使えます。

返り値（数値型）

　メールのバージョン番号を１００倍した値です。

例

#ver = dllfunc("HidemaruMailVersion");

---

ClearAllUnread関数（TKInfo.dll）

　この関数は、「編集・すべて既読にする」コマンドを実行します。これを実行すると、現在のフォルダ中の未読メールがすべて既読になります。

返り値（数値型）

　返り値に意味はありません。

例

#n = dllfunc("ClearAllUnread");

---

RemakeList関数（TKInfo.dll）

　この関数は、パラメータで指定されたフォルダ用のメール一覧を作成し直します。何らかの理由でメール用のファイルを直接編集して保存した場合に使います。

　メール用のファイルを秀丸メール以外のソフトで編集した場合（しかも、秀丸メール起動中の場合）には、この関数でメール一覧の作成し直しを指示するか、または秀丸メールを再起動させる等してください。そうしなければ秀丸メール側でエラーが発生します（エラーが起きても自動的に修復するようにはなっていますが）。

　この関数は秀丸メール本体側でのみ実行可能です。

　この関数を使う/使わないに限らず、メール用のファイルを変更した場合にはそのフォルダ内のメールを開いているエディタを速やかに終了させてください。そうしないと矛盾が起きる場合があります。

パラメータ１（文字列型）

　対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。

パラメータ２（文字列型）

　対象のメール用のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
　パラメータ１とパラメータ２の両方に""を指定すると、現在選択しているフォルダという意味になります。

返り値（数値型）

　選択に成功すると１、失敗すると０を返します。

例

#n = dllfunc( "RemakeList", "テストアカウント", "受信" );

---

OpenedEditorWnd関数（TKInfo.dll）

　この関数は、秀丸メール本体ウィンドウ上で現在選択しているメール（点線のフォーカスが付いてるメール）をメールエディタで開いている場合に、そのウィンドウハンドルを返します。選択しているメールが秀丸エディタで開いてない場合は0を返します。
　この関数は、秀丸メール本体ウィンドウ上でしか実行できません。

返り値（数値型）

　メールエディタ・ウィンドウのハンドルです。

例

#wnd = dllfunc( "OpenedEditorWnd" );
if( #wnd != 0 ) {
    setactivehidemaru #wnd;
}

---

IsPasswordProtected関数（TKInfo.dll）

　この関数は、秀丸メール起動時のパスワードが設定されているかどうか、および「アイコンから復帰する時にもパスワードを要求する」がONかどうかを返します。

返り値（数値型）

　パスワードが設定されてない場合は0を返します。
　パスワードが設定されていて、「アイコンから復帰する時にもパスワードを要求する」がOFFの場合は1を返します。
　パスワードが設定されていて、「アイコンから復帰する時にもパスワードを要求する」がONの場合は2を返します。

例

if( dllfunc("IsPasswordProtected") ) {
    message "パスワードが設定されているのでこのマクロは使えません。";
}

---

SetHotIcon関数（TKInfo.dll）

　この関数は、秀丸メール本体およびタスクトレー中の常駐秀丸メールのアイコンを、「新着メールあり」のアイコンにしたり、逆に新着メールありアイコンから普通のアイコンに戻したりします。

パラメータ１（数値型）

　新着メールあり状態にするなら１、新着メールあり状態を解除するなら０を指定します。

返り値（数値型）

　秀丸メール本体ウィンドウが送受信系コマンド実行中の場合は、アイコンを変化させることなく０を返します。
　送受信中でない場合は１を返しますが、この場合は必ずしもアイコンが変化しているとは限りません。具体的には、秀丸メール本体ウィンドウがアクティブな状態で「新着メールあり」を指示しても、それはそれでキャンセルされつつ、返り値は１となります。
　新着メールあり状態を解除する指示については、送受信中でない限り、必ず成功します。

例

#n = dllfunc("SetHotIcon", 0);

---

RefreshFolder関数（TKInfo.dll）

　この関数は、アカウント一覧／フォルダ一覧をもう一度読み込み直しして、それを元に、フォルダ枠を再構築します。

　メール用のアカウントやフォルダ類を秀丸メールのコマンドを経由せずに作成／削除したあとに、その変更されたことを秀丸メールに反映させるのに使います。

返り値（数値型）

　返り値には意味がありません。

例

#n = dllfunc("RefreshFolder");

---

GetFolderIcon, SetFolderIcon関数（TKInfo.dll）

　GetFolderIcon関数は、現在選択しているフォルダのアイコンの種類を返します。SetFolderIcon関数は、現在選択しているフォルダのアイコンをパラメータで指定されたアイコンに変更します。
　これらの関数が対象と出来るのは、ユーザー様が作成したフォルダだけです。


SetFolderIcon関数のパラメータ１（数値型）

　アイコンの種類を0〜7の数値で指定します。0が標準のアイコン、1が赤、２が緑、他、フォルダ毎の設定でのアイコンの並び順と同じです。

返り値（数値型）

　SetFolderIcon関数もGetFolderIcon関数も、現在選択しているフォルダのアイコンの種類を数値で返します。

例

#n = dllfunc("SetFolderIcon", 2);

---