Função TdhGetWppProperty (tdh.h)

  • Artigo

Recupera uma propriedade específica associada a uma mensagem WPP.

Sintaxe

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

Parâmetros

[in] Handle

Tipo: TDH_HANDLE

Um identificador de decodificação válido.

[in] EventRecord

Tipo: PEVENT_RECORD

O registro de evento passado para o retorno de chamada EventRecordCallback .

[in] PropertyName

Tipo: PWSTR

O nome da propriedade a ser recuperada.

Para obter uma lista de valores possíveis, consulte PROPERTY_DATA_DESCRIPTOR.

[in, out] BufferSize

Tipo: PULONG

Tamanho do parâmetro Buffer , em bytes.

[out] Buffer

Tipo: PBYTE

Buffer alocado pelo usuário que recebe os dados da propriedade.

Retornar valor

Tipo: ULONG

Retorna ERROR_SUCCESS se tiver êxito. Caso contrário, essa função retornará um dos seguintes códigos de retorno, além de outros.

Código de retorno Descrição
ERROR_NOT_FOUND
 A propriedade especificada não foi encontrada.
ERROR_INSUFFICIENT_BUFFER
 BufferSize é muito pequeno. Para obter o tamanho do buffer necessário, chame TdhGetWppProperty duas vezes, uma vez com um buffer nulo e um ponteiro para recuperar o tamanho do buffer e, em seguida, novamente com o buffer de tamanho correto.
ERROR_INVALID_PARAMETER
 Um ou mais dos parâmetros estão incorretos. Esse erro será retornado se o parâmetro Handle, EventRecord, PropertyName ou Buffer for NULL.

Comentários

Para recuperar apenas a mensagem de evento decodificada sem especificar um nome de propriedade, chame TdhGetWppMessage.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho tdh.h
Biblioteca Tdh.lib
DLL Tdh.dll

Confira também

EVENT_RECORD

EventRecordCallback

TdhGetPropertySize

TdhGetWppMessage