IndicatorDelete

Supprime un indicateur ayant le nom spécifié dans la fenêtre spécifiée du graphique.

bool  IndicatorDelete(
   int            sub_win       // numéro de la sous-fenêtre
   const string   name          // nom court de l'indicateur
   );

Paramètres

sub_win

[in]  Numéro de la sous-fenêtre du graphique. 0 signifie la fenêtre du graphique principal.

const name

[in]  Le nom court de l'indicateur qui est spécifié dans la propriété INDICATOR_SHORTNAME avec la fonction IndicatorSetString(). Pour obtenir le nom court d'un indicateur, utiliser la fonction IndicatorName() .

Valeur de Retour

Retourne vrai si l'indicateur a été supprimé avec succès. Sinon retourne faux. Pour obtenir les détails de l'erreur, utilisez la fonction GetLastError().

Note

Si deux indicateurs avec des noms courts identiques existent dans la sous-fenêtre du graphique, le premier sera supprimé.

Si d'autres indicateurs sur ce graphique sont basés sur les valeurs de l'indicateur en cours de suppression, ces indicateurs seront supprimés.

Ne pas confondre le nom court de l'indicateur et le nom du fichier spécifié lors de la création d'un indicateur en utilisant les fonctions iCustom() et IndicatorCreate(). Si le nom court d'un indicateur n'est pas défini explicitement, alors le nom du fichier contenant le code source de l'indicateur sera défini pendant la compilation.

La suppression d'un indicateur d'un graphique ne signifie pas que les calculs seront supprimés de la mémoire du terminal. Pour relâcher le handle de l'indicateur, utiliser la fonction IndicatorRelease().

Le nom court de l'indicateur doit être formé correctement. Il sera affecté à la propriété INDICATOR_SHORTNAME avec la fonction IndicatorSetString(). Il est recommendé que le nom court contienne tous les paramêtres d'entrée de l'indicateur, car l'indicateur à supprimer du graphique par la fonction IndicatorDelete() est identifié par son nom court.

Voir aussi

IndicatorAdd(), IndicatorsTotal(), IndicatorName(), iCustom(), IndicatorCreate(), IndicatorSetString().