EvtOpenChannelEnum 関数 (winevt.h)

コンピューターに登録されているチャネルの一覧を列挙するために使用するハンドルを取得します。

構文

EVT_HANDLE EvtOpenChannelEnum(
  [in] EVT_HANDLE Session,
  [in] DWORD      Flags
);

パラメーター

[in] Session

EvtOpenSession 関数が返すリモート セッション ハンドル。 ローカル コンピューター上のチャネルを列挙するには 、NULL に設定します。

[in] Flags

予約済み。 ゼロを指定してください。

戻り値

成功した場合、関数は、コンピューターに登録されているチャネル名の一覧にハンドルを返します。それ以外の場合は NULL。 NULL の場合は、GetLastError 関数を呼び出してエラー コードを取得します。

注釈

列挙には、コンピューターに登録されているプロバイダーが定義したすべてのチャネルが含まれます。 チャネル名を列挙するには、ループ内で EvtNextChannelPath 関数を呼び出します。 名前はアルファベット順に並べ替えられます。

完了したら列挙子ハンドルを閉じるには、 EvtClose 関数を呼び出す必要があります。

例

この関数の使用方法を示す例については、「チャネルの 構成プロパティの取得と設定」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	winevt.h
Library	Wevtapi.lib
[DLL]	Wevtapi.dll

こちらもご覧ください

EvtNextChannelPath

EvtOpenChannelConfig