EcGetSubscriptionProperty, fonction (evcoll.h)

La fonction EcGetSubscriptionProperty récupère une valeur de propriété spécifique à partir d’un objet d’abonnement. L’objet d’abonnement est spécifié par le handle passé dans le paramètre Subscription .

Syntaxe

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
);

Paramètres

[in] Subscription

Handle de l’objet d’abonnement.

[in] PropertyId

Identificateur qui spécifie la propriété de l’abonnement à obtenir. Spécifiez une valeur de l’énumération EC_SUBSCRIPTION_PROPERTY_ID . Si vous spécifiez la valeur EcSubscriptionEventSources , un handle à un tableau (EC_OBJECT_ARRAY_PROPERTY_HANDLE) est retourné. Vous pouvez ensuite utiliser les fonctions EcGetObjectArrayProperty et EcSetObjectArrayProperty pour obtenir et définir les propriétés Address, Enabled, UserName et Password dans le tableau.

[in] Flags

Réservé. Doit être NULL.

[in] PropertyValueBufferSize

Taille de la mémoire tampon fournie par l’utilisateur dans laquelle stocker la valeur de propriété.

[in] PropertyValueBuffer

Mémoire tampon fournie par l’utilisateur dans laquelle stocker la valeur de propriété.

[out] PropertyValueBufferUsed

Taille de la mémoire tampon fournie par l’utilisateur utilisée par la fonction lors d’un retour réussi, ou taille nécessaire pour stocker la valeur de propriété en cas d’échec de la fonction avec ERROR_INSUFFICIENT_BUFFER.

Valeur retournée

Cette fonction retourne BOOL.

Configuration requise

Voir aussi

Fonctions du collecteur d’événements Windows