EvtGetPublisherMetadataProperty 関数 (winevt.h)

指定したプロバイダー メタデータ プロパティを取得します。

構文

BOOL EvtGetPublisherMetadataProperty(
  [in]  EVT_HANDLE                         PublisherMetadata,
  [in]  EVT_PUBLISHER_METADATA_PROPERTY_ID PropertyId,
  [in]  DWORD                              Flags,
  [in]  DWORD                              PublisherMetadataPropertyBufferSize,
  [in]  PEVT_VARIANT                       PublisherMetadataPropertyBuffer,
  [out] PDWORD                             PublisherMetadataPropertyBufferUsed
);

パラメーター

[in] PublisherMetadata

EvtOpenPublisherMetadata 関数が返すメタデータへのハンドル。

[in] PropertyId

取得するメタデータ プロパティの識別子。 プロパティ識別子の一覧については、 EVT_PUBLISHER_METADATA_PROPERTY_ID 列挙を参照してください。

[in] Flags

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

[in] PublisherMetadataPropertyBufferSize

PublisherMetadataPropertyBuffer バッファーのサイズ (バイト単位)。

[in] PublisherMetadataPropertyBuffer

メタデータ プロパティを受け取る呼び出し元によって割り当てられたバッファー。 バッファーには 、EVT_VARIANT オブジェクトが含まれています。 このパラメーターを NULL に設定して、必要なバッファー サイズを決定できます。

[out] PublisherMetadataPropertyBufferUsed

関数が使用した呼び出し元によって割り当てられたバッファーのサイズ (バイト単位)、または関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は必要なバッファー サイズ。

戻り値

リターン コード/値	説明
TRUE	関数が正常に実行されました。
FALSE	関数が失敗しました。 エラー コードを取得するには、 GetLastError 関数を呼び出します。

注釈

注意  

EvtGetEventMetadataProperty は、 EventMetadataPropertyBuffer 変数でさまざまな種類の値を返すことができます。 EventMetadataPropertyBuffer-Type> == EvtVarTypeEvtHandle の場合、EventMetadataPropertyBuffer には解放する必要があるハンドルが含まれます。 ハンドルが完了したら、 EvtClose 関数を呼び出します。

 

例

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

要件

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

こちらもご覧ください

EvtOpenPublisherMetadata