第III部〜秀丸マクロのいろはにほへと
　COMオブジェクト操作関連

【２．１】「Windows Script Host」の "WshShell" オブジェクトを使ってみる

WshShell オブジェクト にある、"Popup"メソッドを使ってみます。

秀丸マクロの message文 と同じメッセージを表示する命令ですが、タイムアウト時間を設定でき自動で閉じることが出来ます。
(秀丸エディタ Ver.8.75以降では、message文が拡張され、タイムアウトする事も可能)

Popupメソッドの引数、戻り値は以下になります。

intButton = object.Popup(strText,[nSecondsToWait],[strTitle],[nType])

• 引数

  object

  WshShell オブジェクトを指定します。

  strText

  表示するメッセージ(文字列)

  nSecondsToWait

  タイムアウト時間。0(zero)だと通常のメッセージBOXと同じで、ユーザーの操作を待ち続ける。(数値)

  strTitle

  タイトルバーに表示する内容(文字列)

  nType

  表示するボタンとアイコンを示す数値(数値)

• 戻り値

  intButton

  選択されたボタンを示す数値(数値)

WSH(VBScript)の場合は以下になります。

Set WshShell = WScript.CreateObject("WScript.Shell")
BtnCode = WshShell.Popup("ご機嫌いかがですか?", 7, "お答えください。", 4 + 32)
Wscript.echo BtnCode
Set WshShell = Nothing

これを秀丸マクロに変換していきます。

まず、WshShell オブジェクトを生成するため、createobject 関数を使います。

WSH(VBScript)で実行する場合と違い、秀丸マクロではCOM関連の実行時エラーが出ないので、メソッドの実行やプロパティアクセス結果のチェックを行う必要があります。 createobject関数は戻り値で判断できますが、基本的には getresultex関数 を使い、成功/失敗を判断します。 (getresultex(10) で、COM関連命令が成功したか、失敗したかを返す)

//オブジェクトの生成
#WshShell = createobject("WScript.Shell")
//createobject関数の成功/失敗をチェック
if(#WshShell == 0){ //if(getresultex(10) == false){
    //createobject関数が失敗した場合はメッセージを表示して終了
    message "WScript.Shell オブジェクトの生成に失敗しました。";
    endmacro;
}

次に"Popupメソッド"を呼び出します。

呼び出すメソッドの戻り値によって、命令を使い分けます。

• 数値の場合は、"callmethod_returnnum関数"
• 文字列の場合は、"callmethod_returnstr関数"
• オブジェクトの場合は、"callmethod_returnobj関数"
  (createobject関数と同じく、戻り値が「0」なら、メソッドの呼び出し/オブジェクトの取得に失敗していると判断できます)
• 戻り値がない場合は、"callmethod文"

プロパティの場合は、取得する/設定する内容により命令を使い分けます。

• 数値の場合は、"getpropnum関数"、"setpropnum文"
• 文字列の場合は、"getpropstr関数"、"setpropstr文"
• オブジェクトの場合は、"getpropobj関数"、"setpropobj文"

Popupはメソッドで、戻り値が数値なので"callmethod_returnnum関数"を使いメソッド呼び出します。

#BtnCode = callmethod_returnnum(#WshShell, "Popup", "ご機嫌いかがですか?", 7, "お答えください。", 4 + 32);
//メソッドの呼び出しが成功したか確認
if(getresultex(10) == false){
    //失敗した場合はメッセージを表示して終了
    message "Popupメソッドの呼び出しに失敗しました。";
    endmacro;
}

あとは、結果の表示だけなので、最終的には以下のようなマクロになります。

//オブジェクトの生成
#WshShell = createobject("WScript.Shell");
//createobject関数の成功/失敗をチェック
if(#WshShell == 0){ //if(getresultex(10) == false){
    //createobject関数が失敗した場合はメッセージを表示して終了
    message "WScript.Shell オブジェクトの生成に失敗しました。";
    endmacro;
}
// Popupメソッドの呼び出し、7秒待機する。
#BtnCode = callmethod_returnnum(#WshShell, "Popup", "ご機嫌いかがですか?", 7, "お答えください。", 4 + 32);
//メソッドの呼び出しが成功したか確認
if(getresultex(10) == false){
    //失敗した場合はメッセージを表示して終了
    message "Popupメソッドの呼び出しに失敗しました。";
    endmacro;
}
//結果の表示
message str(#BtnCode);
//オブジェクトの解放
releaseobject #WshShell;
endmacro;

エラー検出処理が入っているのでWSH(VBScript)と比較するとマクロが冗長になってしまいますが、エラー検出をしないと正常動作しない場合に、どこでエラーになっているのか追いかけるのが大変です。面倒ですが、ある程度動作確認が出来るまでは、各メソッドの呼び出しやプロパティアクセス毎にチェックする事をお勧めします。

また、WSH(VBScript、JScript)をつかって、事前に秀丸マクロで実行したい処理を実行してみるのも良いです。そもそも、処理方法自体が間違っているのか、秀丸マクロに変換する時点で間違っているのか判断の材料になります。

【２．２】"Shell"オブジェクトと、"FileSystemObject"オブジェクトを使ってみる

次に、"Shell"オブジェクトと、"FileSystemObject"オブジェクトを使ってファイルの一覧を新規秀丸エディタに出力します。 "Shell"オブジェクトでフォルダを選択し、"FileSystemObject"オブジェクトでファイル一覧を取得します。ファイル一覧(コレクション)にアクセスするため、"getcollection"を使っています。

このマクロでは、色々なオブジェクトのプロパティ・メソッドを使っていることから、戻り値の型に従い getpropobj / getpropstr / callmethod_returnobj / callmethod_returnstrを使い分けています。

各メソッド・プロパティの説明に従い適切な命令を使う必要がありますが、どうしてもわからない場合は、 "member文", "member関数"を使う方法もあります。(プロパティは取得する場合のみで、セットすることは出来ない)

// ファイル一覧の取得
newfile;

//shellオブジェクトの作成
//Set WshShell = Wscript.CreateObject("Shell.Application")
//Set getfolder = WshShell.BrowseForFolder(0,"フォルダを選んでください", &h10)
//If (getfolder Is Nothing) Then
//    WScript.Quit
//End If
//Searchfolder = getfolder.Items.Item.path

//shellオブジェクトの作成
#shell = createobject("Shell.Application");
//createobject関数の成功/失敗をチェック
if(#shell == 0){
    message "Shellのオブジェクト作成に失敗";
    endmacro;
}
insert "shellオブジェクトの作成\n";
insert "フォルダ選択ダイアログの表示\n";
//BrowseForFolder メソッドは、Folderオブジェクトを返す。
#getfolder = callmethod_returnobj(#shell, "BrowseForFolder", 0,"フォルダを選んでください",0x10);
//Folderオブジェクトの取得に成功したかチェック
if(#getfolder == 0){
    //失敗した場合はメッセージを表示して終了
    message "BrowseForFolderが失敗";
    endmacro;
}
insert "getfolder オブジェクト取得\n";

//wshだと、以下の一文で、pathプロパティを取得できるが、
//  Searchfolder = getfolder.Items.Item.path
//秀丸マクロだと、1個づつ順番に取得していく
//Folder オブジェクトから、FolderItems オブジェクトを取得
//FolderItems オブジェクトから、FolderItem オブジェクトを取得
//FolderItem オブジェクトの pathプロパティを参照する

#folderitems = callmethod_returnobj(#getfolder, "Items");
//FolderItems オブジェクトの取得に成功したかチェック
if(#folderitems == 0){
    message "#folderitemsが失敗";
    endmacro;
}
#folderitem = callmethod_returnobj(#folderitems, "Item");
//FolderItem オブジェクト の取得に成功したかチェック
if(#folderitem == 0){
    message "#folderitemが失敗";
    endmacro;
}
//FolderItem オブジェクトの pathプロパティを取得
$Searchfolder = getpropstr(#folderitem, "path");
//メソッドの呼び出しが成功したかどうか確認
if(getresultex(10) == false){
    message "pathプロパティが失敗";
    endmacro;
}
insert "読み込む場所：" + $Searchfolder + "\n";
//#shell は使わないので解放する
releaseobject #shell;

message "出力するファイルの拡張子を入力してください。\n" +
        "一度に複数の拡張子を指定する場合は\";\"で区切ってください。\n" +
        "\".\"は入力しないでください。例)txt;log)\nキャンセルで入力を終了します。";
$chk_ext = "";
while(1){
    $ext = input("拡張子を入力してください。キャンセルで終了");
    if(!result) break;
    if($ext == "")break;
    $chk_ext = $chk_ext + tolower($ext) + ";";
}
if(strlen($chk_ext) > 0){
    insert "表示するファイルの種類:" + $chk_ext + "\n";
    $chk_ext = ";" + $chk_ext;
}else{
    insert "表示するファイルの種類:全て\n";
}

//ファイル一覧の取得
//Set WshFso = Wscript.CreateObject("Scripting.FileSystemObject")
//'フォルダオブジェクトの取得
//Set SFolder = WshFso.GetFolder(Searchfolder)
//'ファイルコレクションを取得
//Set SFiles = SFolder.Files
//for each Checkfile in SFile
//    get_ext = WshFso.GetExtensionName(Checkfile.Path)
//next
/
//ファイル一覧の取得
//FileSystemObject を取得
#WshFso = createobject("Scripting.FileSystemObject");
//createobject関数の成功/失敗をチェック
if(#WshFso == 0){
    message "#folderitemが失敗";
    endmacro;
}

//指定されたフォルダの Folderオブジェクト を取得
#Folder = callmethod_returnobj(#WshFso, "GetFolder", $Searchfolder);
//Folder オブジェクトの取得に成功したかチェック
if(#Folder == 0){
    message "Folderオブジェクトの取得に失敗";
    endmacro;
}
//Folderオブジェクト からファイル一覧(filesコレクション)を取得
#Files  = getpropobj(#Folder,"Files");
// オブジェクトの取得に成功したかチェック
if(getresultex(10) == false){
    message "Filesコレクションの取得に失敗";
    endmacro;
}
insert "ファイルの一覧\n";
while(1){
    //filesコレクションから呼び出し
    //#Fileには、コレクションの中身である「ファイルオブジェクト」が入る
    #File = getcollection(#Files);
    if(#File == 0) break;
    //ファイルオブジェクトから、パスプロパティを読み出し
    $get_filepath = getpropstr(#File, "Path");
    if(getresultex(10) == true){
        //拡張子を取得
        $get_ext = callmethod_returnstr(#WshFso, "GetExtensionName", $get_filepath);
        if(getresultex(10) == true){
            if(strlen($chk_ext) > 0){
                $get_ext = tolower($get_ext);
                if(strstr($chk_ext, ";" + $get_ext + ";") > -1){
                    insert $get_filepath + "\n";
                }
            }else{
                insert $get_filepath + "\n";
            }
        }
    }
}
//filesコレクション を解放
#File = getcollection(#Files, 3);
//各オブジェクトを解放
releaseobject #Files;
releaseobject #Folder;
releaseobject #WshFso;

endmacro;

【２．３】COM関連の特殊な動作

#objDic = createobject("Scripting.Dictionary");
callmethod #objDic, "add", "Key1", "Value1";
callmethod #objDic, "add", "Key2", 2;
callmethod #objDic, "add", 3, "Value3";

#objKeys = member(#objDic, "Keys"); //ここでオブジェクトに変換される

#c = getpropnum(#objKeys, "Count"); //"Count"で要素数

$key = getpropstr(#objKeys, "Item", #i); //"Item"で要素
if(getresultex(10)!=false){
    //「getpropstr」が成功した場合
    <省略>
    #i=#i+1;
    continue;
}
#key = getpropnum(#objKeys, "Item", #i); //"Item"で要素
if(getresultex(10)!=false){
    //「getpropnum」が成功した場合
    <省略>
    #i=#i+1;
    continue;
}

「.NET Freamework」のクラス

「.NET Freamework」のクラスも、COMから使える物もあります。

以下のコレクションクラスを使えることが確認されています。

• ArrayList(System.Collections.ArrayList)
  動的配列
• Hashtable(System.Collections.Hashtable)
  連想配列
• SortedList(System.Collections.SortedList)
  キーによってソートされる連想配列
• Queue(System.Collections.Queue)
  先入れ先出しリスト
• Stack(System.Collections.Stack)
  後入れ先出しリスト

詳細は、以下のページから各クラスのページを参照してください。
System.Collections 名前空間 "ArrayList"は、動的配列なので配列サイズは気にしなくても良いし、ソート/逆順ソートも可能になってます。

連想配列は、WSHでも可能で、Dictionary オブジェクトを使います。

COMオブジェクトの有効範囲

createobject文を実行した秀丸エディタ上のみ有効です。秀丸エディタを切り替えた場合は、無効です。 (DLLのロードと同じ)

次のマクロでは、2回目の"Popup"メソッドは、新規秀丸エディタを開いて呼び出しているため、失敗します。 (新規秀丸エディタ上で、createobjectを実行していないので、"WScript.Shell" オブジェクトは存在してない)

//オブジェクトの生成
#WshShell = createobject("WScript.Shell");
if(#WshShell == 0){ //if(getresultex(10) == false){
    message "WScript.Shell オブジェクトの生成に失敗しました。";
    endmacro;
}
// メソッドの呼び出し、7秒待機する。
#BtnCode = callmethod_returnnum(#WshShell, "Popup", "ご機嫌いかがですか?", 7, "お答えください。", 4 + 32);
if(getresultex(10) == false){
    message "Popupメソッドの呼び出しに失敗しました。(1)";
    endmacro;
}
//結果の表示
message str(#BtnCode);

//新規秀丸エディタを開く
newfile;
// メソッドの呼び出し この行は失敗する。
#BtnCode = callmethod_returnnum(#WshShell, "Popup", "ご機嫌いかがですか?", 7, "お答えください。", 4 + 32);
if(getresultex(10) == false){
    #err = getresultex(11);
    message "Popupメソッドの呼び出しに失敗しました。(2)\n0x" + hex(#err);
    endmacro;
}

//オブジェクトの解放
releaseobject #WshShell;
endmacro;

DLLの場合と違い、呼び出しに失敗してもマクロの実行は止まらない為、異常には気がつきにくいです。 (メソッドの呼び出し、プロパティアクセス後は、エラーチェックをした方が良いです)

COMコンポーネントのメソッドの戻り値や、プロパティの型がわからない場合の確認方法

VBScriptの VarType 関数、TypeName 関数 を使えば、戻り値/プロパティの型を確認できます。 (秀丸エディタマクロ上からは、VarType 関数、TypeName 関数を実行できないので、VBScript から実行する必要あり)

これらの関数の引数に、型を知りたい変数、メソッドの戻り値、プロパティを指定すると TypeName 関数は文字列、VarType 関数は数値で型を示す値を返します。

以下のスクリプトを、コマンドプロンプトから、Cscriptで実行してみます。

a = "秀丸エディタ"
WScript.echo  "VarType:" & VarType(a) & vbCrLf & "TypeName:" & TypeName(a)

Set WshShell = Createobject("WScript.Shell")
WScript.echo  "VarType:" & VarType(WshShell) & vbCrLf & "TypeName:" & TypeName(WshShell)

上記スクリプトの実行結果です。TypeName関数は、オブジェクトの場合、オブジェクト名を返すようです。

VarType :8
TypeName:String
VarType :9
TypeName:IWshShell3

各関数の詳細は以下のリンクを参照。

• TypeName 関数
• VarType 関数