TdhGetWppProperty 関数 (tdh.h)

  • [アーティクル]

WPP メッセージに関連付けられている特定のプロパティを取得します。

構文

TDHSTATUS TdhGetWppProperty(
  [in]      TDH_HANDLE    Handle,
  [in]      PEVENT_RECORD EventRecord,
  [in]      PWSTR         PropertyName,
  [in, out] PULONG        BufferSize,
  [out]     PBYTE         Buffer
);

パラメーター

[in] Handle

種類: TDH_HANDLE

有効なデコード ハンドル。

[in] EventRecord

種類: PEVENT_RECORD

EventRecordCallback コールバックに渡されるイベント レコード。

[in] PropertyName

種類: PWSTR

取得するプロパティの名前。

使用可能な値の一覧については、「 PROPERTY_DATA_DESCRIPTOR」を参照してください。

[in, out] BufferSize

種類: PULONG

Buffer パラメーターのサイズ (バイト単位)。

[out] Buffer

種類: PBYTE

プロパティ データを受け取るユーザー割り当てバッファー。

戻り値

種類: ULONG

成功した場合は、ERROR_SUCCESSを返します。 それ以外の場合、この関数は、他の戻りコードに加えて、次のいずれかのリターン コードを返します。

リターン コード 説明
ERROR_NOT_FOUND
 指定されたプロパティが見つかりませんでした。
ERROR_INSUFFICIENT_BUFFER
 BufferSize が小さすぎます。 必要なバッファー サイズを取得するには、 TdhGetWppProperty を 2 回呼び出します。1 回は null バッファーとポインターを使用してバッファー サイズを取得し、正しいサイズのバッファーを使用して再度呼び出します。
ERROR_INVALID_PARAMETER
 1 つ以上のパラメーターが正しくありません。 このエラーは、 Handle、 EventRecord、 PropertyName、または Buffer パラメーターが NULL の場合に返されます。

注釈

プロパティ名を指定せずにデコードされたイベント メッセージのみを取得するには、 TdhGetWppMessage を呼び出します。

要件

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

こちらもご覧ください

EVENT_RECORD

EventRecordCallback

TdhGetPropertySize

TdhGetWppMessage