Enum リファレンス

COM のコレクション(FolderItems、Scripting.FileSystemObject の Drives、TabCtrl など)を順に列挙する Enum オブジェクトのリファレンスです。JScript の Enumerator に相当します。

• 関連: te リファレンス、api リファレンス(api.CreateObject)、FolderItems リファレンス、TabCtrl リファレンス

記法: M=メソッド。メンバー名の照合は大文字小文字を区別しません。

目次

1. 取得方法
2. メソッド
3. 列挙できるもの
4. 注意点
5. 使用例

1. 取得方法

api.CreateObject("Enum", collection)

const e = api.CreateObject("Enum", fso.Drives);

• 第2引数に、列挙したいコレクション(オブジェクト)を渡します。省略すると何も列挙できません(作成はされますが、すぐに atEnd() が真になります)。
• 作成した時点で、最初の要素を先に取り出しています。moveFirst() を呼ぶ必要はありません。
• te.Enum のような te 側の入口はありません。

2. メソッド

典型的なループは次の形です(Enumerator と同じです)。

for (const e = api.CreateObject("Enum", collection); !e.atEnd(); e.moveNext()) {
    const item = e.item();
}

3. 列挙できるもの

次の順に判定して、最初に成り立ったものを使います。

• 列挙子が使えるオブジェクトのときの moveFirst() は、元の列挙子の Reset() を呼びます。メンバー名を返す場合は、先頭から数え直します。
• メンバー名の列挙で、配列(Array)を渡した場合の動作(添字が文字列で返るかなど)は、スクリプトエンジンに依存するため要確認です。

4. 注意点

• 要素は列挙するたびに取り出されるため、列挙中にコレクションを変更すると結果が不定になります。
• atEnd() の判定は、直前に要素を取り出せたかどうかで決まります。要素を取り出さずに atEnd() だけを繰り返すと終わりません(moveNext() を必ず呼ぶこと)。
• 非同期スクリプト(ui.js など WebView2 側)では、CreateObject を含む各メソッド呼び出しに await が必要です。

5. 使用例

// ドライブを列挙(Scripting.FileSystemObject)
const fso = api.CreateObject("Scripting.FileSystemObject");
for (const e = api.CreateObject("Enum", fso.Drives); !e.atEnd(); e.moveNext()) {
    const drive = e.item();
    // drive.DriveLetter, drive.TotalSize ...
}

// FolderItems を列挙
const Items = FV.SelectedItems();
for (const e = api.CreateObject("Enum", Items); !e.atEnd(); e.moveNext()) {
    const path = e.item().Path;
}

// プロパティ名を列挙
const o = api.CreateObject("Object");
o.a = 1;
o.b = 2;
for (const e = api.CreateObject("Enum", o); !e.atEnd(); e.moveNext()) {
    const key = e.item();     // "a", "b"
}

// 非同期スクリプト(WebView2 側)
for (let list = await api.CreateObject("Enum", collection); !await list.atEnd(); await list.moveNext()) {
    const item = await list.item();
}

FolderItems の列挙は、通常は for...in や添字アクセスのほうが簡単です(FolderItems は Count と Item(i) で、TabCtrl も for...in で列挙できます)。Enum は、_NewEnum だけを提供する COM コレクションや、メンバー名の列挙に使います。

関連

• te リファレンス
• api リファレンス
• FolderItems リファレンス
• TabCtrl リファレンス