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。 否則，除了其他傳回碼之外，此函式還會傳回下列其中一個傳回碼。

傳回碼 Description
ERROR_NOT_FOUND
 找不到指定的屬性。
ERROR_INSUFFICIENT_BUFFER
 BufferSize 太小。 若要取得所需的緩衝區大小，請呼叫 TdhGetWppProperty 兩次，一次具有 Null 緩衝區和指標來擷取緩衝區大小，然後再呼叫正確重設大小的緩衝區。
ERROR_INVALID_PARAMETER
 一或多個參數不正確。 如果 Handle、 EventRecord、 PropertyName 或 Buffer 參數為 NULL，就會傳回 此錯誤。

備註

若只要擷取譯碼的事件訊息而不指定屬性名稱，請呼叫 TdhGetWppMessage。

規格需求

需求 值
最低支援的用戶端 Windows 8 [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2012 [僅限傳統型應用程式]
目標平台 Windows
標頭 tdh.h
程式庫 Tdh.lib
Dll Tdh.dll

另請參閱

EVENT_RECORD

EventRecordCallback

TdhGetPropertySize

TdhGetWppMessage