ObjectsDeleteAll

Supprime tous les objets du graphique indiqué, dans la sous-fenêtre indiquée du graphique indiqué, du type indiqué.

int  ObjectsDeleteAll(
   long  chart_id,           // identificateur du graphique
   int   sub_window=-1,      // index de la fenêtre
   int   type=-1             // type de l'objet à effacer
   );

Supprime tous les objets du type spécifié et utilisant le préfixe indiqué dans leur nom.

int  ObjectsDeleteAll(
   long           chart_id,  // identifiant du graphique
   const string     prefix,  // préfixe dans le nom de l'objet
   int       sub_window=-1,  // indice de la fenêtre
   int      object_type=-1   // type des objets
   );

Paramètres

chart_id

[in]  L'identificateur du graphique. 0 signifie le graphique courant.

prefix

[in]  Préfixe dans les noms des objets. Tous les objets dont le nom commence avec cet ensemble de caractères seront supprimés du graphique. Vous pouvez spécifier le préfixe sous la forme 'nom' ou 'nom*' — les 2 variantes fonctionneront de la même façon. Si une chaîne vide est spécifiée comme préfixe, tous les objets avec tous les noms possibles seront supprimés.

sub_window=-1

[in]  Le numéro de la sous-fenêtre du graphique. 0 signifie une fenêtre principale du graphique, -1 signifie tous les sous-fenêtres du graphique, y compris une fenêtre principale.

type=-1

[in] Le type de l'objet. La valeur peut être une des valeurs de l'énumération ENUM_OBJECT. -1 signifie tous les types.

Valeur de Retour

Retourne le nombre d'objets supprimés. Pour obtenir des informations supplémentaires sur l'erreur, il est nécessaire d'appeler la fonction GetLastError().

Note

La fonction utilise un appel synchrone, ce qui signifie que la fonction attend la fin de l'exécution de toutes les commandes présentes dans la queue de ce graphique avant cet appel. C'est pourquoi cette fonction peut être consommatrice en terme de temps. Cette caractéristique doit être prise en compte lors de l'utilisation d'un grand nombre d'objets sur un graphique.