Aller au contenu principal
Version: v4 (Stable)

EnumObject

EnumObject(ObjectType As Integer, ObjectId as Integer, sName As String[, Flag As Integer, Param As Integer/String[, bRelief As Boolean[, StationId As Integer]]]) As Integer

Enumère tous les objets d'un type donné. Si un objet est trouvé, son ID est retourné dans <ObjectId> et son nom dans <sName> (identificateur complet de la variable si serveur de données non spécifié, simple identificateur de la variable sinon).

Le type d'objet recherché est passé dans le champ <ObjectType> : 0 = Variables 1 = Alarmes 2 = Utilisateurs 3 = Groupes d'astreinte 4 = Groupes d'alarme 5 = Drivers de communication 6 = Equipes 10 = Stations 23 = Groupes de serveurs de données 26 = Serveurs de données 27 = Scénarios 31 = Groupements de groupes d'astreinte 36 = Groupements de scénarios

La recherche doit commencer par l'Id 0 puis pour les énumérations suivantes il faut redonner le dernier Id trouvé.

Le paramètre <Flag> peut spécifier un filtre particulier définit par <Param> (nom d'objet ou OId) : Flag = 1 : filtre sur objets attachés à l'opérateur <Param>. Flag = 2 : filtre sur objets attachés au groupe d'alarme <Param>  (Le nom doit inclure les parents : nom complet avec séparateur /). Flag = 3 : filtre sur objets attachés à l'équipe <Param>. Flag = 4 : filtre sur objets attachés au groupe d'astreinte <Param>. Flag = 5 : filtre sur objets attachés au groupe d'alarme <Param> (Nom du groupe sans les parents). Flag = 6 : filtre sur objets attachés au serveur de données <Param>. Flag = &h10 : filtre sur variables de type OPC. Flag = &h20 : filtre sur variables de type DDE. Flag = &h30 : filtre sur variables de type autre. Flag = &h40 : filtre sur variables de type driver. Flag = &h80 : ne traite que les variables du serveur de données (valeur par défaut). Flag = &h100 : liste les variables de type alarme masquées.

Le paramètre optionnel <bRelief> retourne l'état de repli de l'opérateur retourné dans la groupe ou l'équipe spécifié.

Le paramètre optionnel <StationId> permet de filtrer la recherche sur la station définie (StationId). S'il est omis ou fixé à 0, la recherche s'effectue sur toutes les stations.

Retourne 0 si l'objet est trouvé ou un code d'erreur sinon.