Share via

EvtGetObjectArrayProperty 関数 (winevt.h)

  • [アーティクル]

配列内の指定したオブジェクトからプロバイダー メタデータ プロパティを取得します。

構文

BOOL EvtGetObjectArrayProperty(
  [in]  EVT_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in]  DWORD                            PropertyId,
  [in]  DWORD                            ArrayIndex,
  [in]  DWORD                            Flags,
  [in]  DWORD                            PropertyValueBufferSize,
  [in]  PEVT_VARIANT                     PropertyValueBuffer,
  [out] PDWORD                           PropertyValueBufferUsed
);

パラメーター

[in] ObjectArray

EvtGetPublisherMetadataProperty 関数が返すオブジェクトの配列へのハンドル。

[in] PropertyId

指定したオブジェクトから取得するメタデータ プロパティのプロパティ識別子。 使用可能な値については、 EVT_PUBLISHER_METADATA_PROPERTY_IDの「解説」セクションを参照してください。

[in] ArrayIndex

配列内のオブジェクトの 0 から始まるインデックス。

[in] Flags

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

[in] PropertyValueBufferSize

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

[in] PropertyValueBuffer

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

[out] PropertyValueBufferUsed

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

戻り値

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

注釈

次の ID を使用して EvtGetPublisherMetadataProperty 関数を呼び出すと、関数はその型のオブジェクトの配列へのハンドルを返します。

  • EvtPublisherMetadataChannelReferences
  • EvtPublisherMetadataLevels
  • EvtPublisherMetadataTasks
  • EvtPublisherMetadataOpcodes
  • EvtPublisherMetadataKeywords
たとえば、EvtPublisherMetadataKeywords を EvtGetPublisherMetadataProperty に渡すと、関数は キーワード (keyword) オブジェクトの配列にハンドルを返します。

配列のサイズを確認するには、 EvtGetObjectArraySize 関数を呼び出します。

例

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

要件

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

こちらもご覧ください

EVT_PUBLISHER_METADATA_PROPERTY_ID

EvtGetPublisherMetadataProperty