EcGetObjectArrayProperty, fonction (evcoll.h)
La fonction EcGetObjectArrayProperty récupère les valeurs de propriété d’un handle vers un tableau de propriétés source d’événement. Le tableau contient des valeurs de propriété pour les sources d’événements d’un abonnement.
Syntaxe
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
);
Paramètres
[in] ObjectArray
Handle d’un tableau de propriétés pour les sources d’événements d’un abonnement. Handle de tableau retourné par la méthode EcGetSubscriptionProperty lorsque la valeur EcSubscriptionEventSources est passée dans le paramètre PropertyId .
[in] PropertyId
Identificateur de propriété pour les propriétés du tableau. Spécifiez une valeur à partir de l’énumération EC_SUBSCRIPTION_PROPERTY_ID . Obtenez les propriétés Address, Enabled, UserName et Password dans le tableau en spécifiant les valeurs EcSubscriptionEventSourceAddress, EcSubscriptionEventSourceEnabled, EcSubscriptionEventSourceUserName ou EcSubscriptionEventSourcePassword .
[in] ArrayIndex
Index du tableau qui spécifie la source d’événement à partir de laquelle obtenir la propriété.
[in] Flags
Réservé. Doit être égal à 0.
[in] PropertyValueBufferSize
Taille de la mémoire tampon qui contient la valeur de la propriété. La taille doit être au moins la taille d’une valeur EC_VARIANT .
[in] PropertyValueBuffer
Mémoire tampon fournie par l’utilisateur dans laquelle stocker la valeur de la propriété.
[out] PropertyValueBufferUsed
Taille de la mémoire tampon fournie par l’utilisateur utilisée par la fonction en cas de retour réussi, ou taille nécessaire pour stocker la valeur de la propriété en cas d’échec de la fonction avec ERROR_INSUFFICIENT_BUFFER.
Valeur retournée
Cette fonction retourne BOOL.
Remarques
Les tableaux étant de base zéro, l’index du premier élément du tableau est 0.
La propriété Password d’une source d’événement ou de l’abonnement ne peut pas être récupérée. Pour des raisons de sécurité, une chaîne vide est retournée pour la valeur de la propriété et la dernière erreur est définie sur ERROR_ACCESS_DENIED.
Un abonnement peut avoir plusieurs sources d’événements, et chaque source peut avoir une propriété Address, Enabled, UserName et Password .
Exemples
Pour obtenir un exemple de code utilisant la fonction EcGetObjectArrayProperty , consultez Affichage des propriétés d’un abonnement collecteur d’événements.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows Vista |
| Serveur minimal pris en charge | Windows Server 2008 |
| Plateforme cible | Windows |
| En-tête | evcoll.h |
| Bibliothèque | Wecapi.lib |
| DLL | Wecapi.dll |