Share via


EvtGetChannelConfigProperty 関数 (winevt.h)

指定したチャネル構成プロパティを取得します。

構文

BOOL EvtGetChannelConfigProperty(
  [in]  EVT_HANDLE                     ChannelConfig,
  [in]  EVT_CHANNEL_CONFIG_PROPERTY_ID PropertyId,
  [in]  DWORD                          Flags,
  [in]  DWORD                          PropertyValueBufferSize,
  [in]  PEVT_VARIANT                   PropertyValueBuffer,
  [out] PDWORD                         PropertyValueBufferUsed
);

パラメーター

[in] ChannelConfig

EvtOpenChannelConfig 関数が返すチャネルの構成プロパティへのハンドル。

[in] PropertyId

取得するチャネル プロパティの識別子。 プロパティ識別子の一覧については、 EVT_CHANNEL_CONFIG_PROPERTY_ID 列挙を参照してください。

[in] Flags

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

[in] PropertyValueBufferSize

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

[in] PropertyValueBuffer

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

[out] PropertyValueBufferUsed

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

戻り値

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

要件

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

こちらもご覧ください

EvtOpenChannelConfig