Função EcGetObjectArrayProperty (evcoll.h)

A função EcGetObjectArrayProperty recupera valores de propriedade de um identificador para uma matriz de propriedades de origem do evento. A matriz contém valores de propriedade para as fontes de evento de uma assinatura.

Sintaxe

BOOL EcGetObjectArrayProperty(
  [in]  EC_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in]  EC_SUBSCRIPTION_PROPERTY_ID     PropertyId,
  [in]  DWORD                           ArrayIndex,
  [in]  DWORD                           Flags,
  [in]  DWORD                           PropertyValueBufferSize,
  [in]  PEC_VARIANT                     PropertyValueBuffer,
  [out] PDWORD                          PropertyValueBufferUsed
);

Parâmetros

[in] ObjectArray

Um identificador para uma matriz de propriedades para as fontes de evento de uma assinatura. Um identificador de matriz retornado pelo método EcGetSubscriptionProperty quando o valor EcSubscriptionEventSources é passado para o parâmetro PropertyId .

[in] PropertyId

O identificador de propriedade para propriedades na matriz. Especifique um valor da enumeração EC_SUBSCRIPTION_PROPERTY_ID . Obtenha as propriedades Address, Enabled, UserName e Password na matriz especificando os valores EcSubscriptionEventSourceAddress, EcSubscriptionEventSourceEnabled, EcSubscriptionEventSourceUserName ou EcSubscriptionEventSourcePassword .

[in] ArrayIndex

O índice da matriz que especifica de qual origem do evento obter a propriedade.

[in] Flags

Reservado. Deve ser 0.

[in] PropertyValueBufferSize

O tamanho do buffer que contém o valor da propriedade . O tamanho deve ter pelo menos o tamanho de um valor EC_VARIANT .

[in] PropertyValueBuffer

O buffer fornecido pelo usuário no qual armazenar o valor da propriedade.

[out] PropertyValueBufferUsed

O tamanho do buffer fornecido pelo usuário usado pela função no retorno bem-sucedido ou o tamanho necessário para armazenar o valor da propriedade quando a função falhar com ERROR_INSUFFICIENT_BUFFER.

Retornar valor

Essa função retorna BOOL.

Comentários

As matrizes são baseadas em zero, portanto, o índice do primeiro item na matriz é 0.

A propriedade Password para uma origem de evento ou a assinatura não pode ser recuperada. Por motivos de segurança, uma cadeia de caracteres vazia é retornada para o valor da propriedade e o último erro será definido como ERROR_ACCESS_DENIED.

Uma assinatura pode ter várias fontes de eventos e cada fonte pode ter uma propriedade Address, Enabled, UserName e Password .

Exemplos

Por exemplo, código usando a função EcGetObjectArrayProperty , consulte Exibindo as propriedades de uma assinatura do coletor de eventos.

Requisitos

Confira também

Funções do Coletor de Eventos do Windows