Compartilhar via

Função EvtGetObjectArrayProperty (winevt.h)

  • Artigo

Obtém uma propriedade de metadados do provedor do objeto especificado na matriz.

Sintaxe

BOOL EvtGetObjectArrayProperty(
  [in]  EVT_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in]  DWORD                            PropertyId,
  [in]  DWORD                            ArrayIndex,
  [in]  DWORD                            Flags,
  [in]  DWORD                            PropertyValueBufferSize,
  [in]  PEVT_VARIANT                     PropertyValueBuffer,
  [out] PDWORD                           PropertyValueBufferUsed
);

Parâmetros

[in] ObjectArray

Um identificador para uma matriz de objetos que a função EvtGetPublisherMetadataProperty retorna.

[in] PropertyId

O identificador de propriedade da propriedade de metadados que você deseja obter do objeto especificado. Para obter valores possíveis, consulte a seção Comentários de EVT_PUBLISHER_METADATA_PROPERTY_ID.

[in] ArrayIndex

O índice baseado em zero do objeto na matriz.

[in] Flags

Reservado. Deve ser zero.

[in] PropertyValueBufferSize

O tamanho do buffer PropertyValueBuffer , em bytes.

[in] PropertyValueBuffer

Um buffer alocado pelo chamador que receberá a propriedade de metadados. O buffer contém um objeto EVT_VARIANT . Você pode definir esse parâmetro como NULL para determinar o tamanho do buffer necessário.

[out] PropertyValueBufferUsed

O tamanho, em bytes, do buffer alocado pelo chamador que a função usou ou o tamanho do buffer necessário se a função falhar com ERROR_INSUFFICIENT_BUFFER.

Retornar valor

Valor/código retornado Descrição
TRUE
 A função foi bem-sucedida.
FALSE
 A função falhou. Para obter o código de erro, chame a função GetLastError .

Comentários

Quando você chama a função EvtGetPublisherMetadataProperty com as seguintes IDs, a função retorna um identificador para uma matriz de objetos desse tipo:

  • EvtPublisherMetadataChannelReferences
  • EvtPublisherMetadataLevels
  • EvtPublisherMetadataTasks
  • EvtPublisherMetadataOpcodes
  • EvtPublisherMetadataKeywords
Por exemplo, se você passar EvtPublisherMetadataKeywords para EvtGetPublisherMetadataProperty, a função retornará um identificador para uma matriz de objetos palavra-chave.

Para determinar o tamanho da matriz, chame a função EvtGetObjectArraySize .

Exemplos

Para obter um exemplo que mostra como usar essa função, consulte Obtendo metadados de um provedor.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho winevt.h
Biblioteca Wevtapi.lib
DLL Wevtapi.dll

Confira também

EVT_PUBLISHER_METADATA_PROPERTY_ID

EvtGetPublisherMetadataProperty