Função EcGetSubscriptionProperty (evcoll.h)

A função EcGetSubscriptionProperty recupera um valor de propriedade específico de um objeto de assinatura. O objeto de assinatura é especificado pelo identificador passado para o parâmetro Subscription .

Sintaxe

BOOL EcGetSubscriptionProperty(
  [in]  EC_HANDLE                   Subscription,
  [in]  EC_SUBSCRIPTION_PROPERTY_ID PropertyId,
  [in]  DWORD                       Flags,
  [in]  DWORD                       PropertyValueBufferSize,
  [in]  PEC_VARIANT                 PropertyValueBuffer,
  [out] PDWORD                      PropertyValueBufferUsed
);

Parâmetros

[in] Subscription

O identificador para o objeto de assinatura.

[in] PropertyId

Um identificador que especifica qual propriedade da assinatura obter. Especifique um valor da enumeração EC_SUBSCRIPTION_PROPERTY_ID . Se você especificar o valor EcSubscriptionEventSources , um identificador para uma matriz (EC_OBJECT_ARRAY_PROPERTY_HANDLE) será retornado. Em seguida, você pode usar as funções EcGetObjectArrayProperty e EcSetObjectArrayProperty para obter e definir as propriedades Address, Enabled, UserName e Password na matriz.

[in] Flags

Reservado. Deve ser NULL.

[in] PropertyValueBufferSize

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

[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.

Requisitos

Confira também

Funções do Coletor de Eventos do Windows