EvtOpenPublisherMetadata 関数 (winevt.h)

指定したプロバイダーのメタデータを読み取るために使用するハンドルを取得します。

構文

EVT_HANDLE EvtOpenPublisherMetadata(
  [in, optional] EVT_HANDLE Session,
  [in]           LPCWSTR    PublisherId,
  [in, optional] LPCWSTR    LogFilePath,
  [in]           LCID       Locale,
  [in]           DWORD      Flags
);

パラメーター

[in, optional] Session

EvtOpenSession 関数が返すリモート セッション ハンドル。 ローカル コンピューター上のプロバイダーのメタデータを取得するには、 NULL に設定します。

[in] PublisherId

プロバイダーの名前。 コンピューターに登録されているプロバイダーの名前を列挙するには、 EvtOpenPublisherEnum 関数を呼び出します。

[in, optional] LogFilePath

プロバイダーがログに記録したイベントを含むアーカイブされたログ ファイルへの完全パス。 アーカイブされたログ ファイルには、プロバイダーのメタデータも含まれます。 プロバイダーがローカル コンピューターに登録されていない場合は、このパラメーターを使用します。 登録済みプロバイダーからメタデータを読み取る場合は NULL に設定します。

[in] Locale

プロバイダーからローカライズされたメタデータにアクセスするときに使用するロケール識別子。 ロケール識別子を作成するには、MAKELCID マクロを使用します。 呼び出し元スレッドのロケール識別子を使用するには、0 に設定します。

[in] Flags

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

戻り値

成功した場合、関数はプロバイダーのメタデータへのハンドルを返します。それ以外の場合は NULL。 NULL の場合は、GetLastError 関数を呼び出してエラー コードを取得します。

解説

アーカイブされたログ ファイルを指定した場合、この関数はログ ファイル内の指定されたプロバイダーのメタデータに対してチェックされます。 プロバイダーのメタデータがログ ファイルに見つからない場合、関数はローカル コンピューター上の登録済みプロバイダーの一覧でプロバイダーを検索します。

プロバイダーのメタデータを読み取るために、 EvtGetPublisherMetadataProperty 関数を呼び出します。 プロバイダーが定義するイベントを列挙するには、 EvtOpenEventMetadataEnum 関数を呼び出します。

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

例

この関数の使用方法を示す例については、「 プロバイダーのメタデータの取得」を参照してください。

要件

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

関連項目

EvtGetPublisherMetadataProperty

EvtOpenEventMetadataEnum

EvtOpenPublisherEnum