TdhGetWppProperty-Funktion (tdh.h)

Ruft eine bestimmte Eigenschaft ab, die einer WPP-Nachricht zugeordnet ist.

Syntax

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

Parameter

[in] Handle

Typ: TDH_HANDLE

Ein gültiges Decodierungshandle.

[in] EventRecord

Typ: PEVENT_RECORD

Der An Ihren EventRecordCallback-Rückruf übergebene Ereignisdatensatz.

[in] PropertyName

Typ: PWSTR

Der Name der abzurufenden Eigenschaft.

Eine Liste der möglichen Werte finden Sie unter PROPERTY_DATA_DESCRIPTOR.

[in, out] BufferSize

Typ: PULONG

Größe des Pufferparameters in Bytes.

[out] Buffer

Typ: PBYTE

Vom Benutzer zugewiesener Puffer, der die Eigenschaftendaten empfängt.

Rückgabewert

Typ: ULONG

Gibt bei erfolgreicher Ausführung ERROR_SUCCESS zurück. Andernfalls gibt diese Funktion zusätzlich zu anderen einen der folgenden Rückgabecodes zurück.

Rückgabecode Beschreibung
ERROR_NOT_FOUND
Die angegebene Eigenschaft wurde nicht gefunden.
ERROR_INSUFFICIENT_BUFFER
BufferSize ist zu klein. Um die erforderliche Puffergröße abzurufen, rufen Sie TdhGetWppProperty zweimal auf, einmal mit einem NULL-Puffer und einem Zeiger, um die Puffergröße abzurufen, und dann erneut mit dem Puffer mit der richtigen Größe.
ERROR_INVALID_PARAMETER
Mindestens ein Parameter ist falsch. Dieser Fehler wird zurückgegeben, wenn der Handle-, EventRecord-, PropertyName- oder Buffer-ParameterNULL ist.

Hinweise

Um nur die decodierte Ereignisnachricht abzurufen, ohne einen Eigenschaftennamen anzugeben, rufen Sie TdhGetWppMessage auf.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2012 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile tdh.h
Bibliothek Tdh.lib
DLL Tdh.dll

Weitere Informationen

EVENT_RECORD

EventRecordCallback

TdhGetPropertySize

TdhGetWppMessage