ChartGetString

Rend la valeur de la propriété correspondante du graphique indiqué. La propriété du graphique doit être du type string. Il y a 2 variantes de la fonction.

1. Rend directement la valeur de la propriété.

string  ChartGetString(
   long                         chart_id,        // identificateur du graphique
   ENUM_CHART_PROPERTY_STRING   prop_id          // identificateur de la propriété
   );

2. Rend true ou false en fonction du succès de l'exécution de la fonction. En cas du succès la valeur de la propriété se place à la variable de réception transmise selon la référence par le dernier paramètre.

bool  ChartGetString(
   long                         chart_id,        // identificateur du graphique
   ENUM_CHART_PROPERTY_STRING   prop_id,         // identificateur de la propriété
   string&                      string_var       // acceptons ici la valeur de la propriété
   );

Paramètres

chart_id

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

prop_id

[in] L'identificateur de la propriété du graphique. La valeur peut être une des valeurs de l'énumération ENUM_CHART_PROPERTY_STRING.

string_var

[out]  La variable du type string, acceptant la valeur de la propriété demandée.

La valeur rendue

La valeur du type string.

Pour la deuxième variante de l'appel rend true, si la propriété donnée est supportée et la valeur était placé à la variable string_var, autrement rend false. Pour recevoir l'information supplémentaire sur l'erreur, il est nécessaire d' appeler la fonction GetLastError().

Note

La fonction ChartGetString peut être utilisée pour la lecture des commentaires affichés sur le graphique par les fonctions Comment ou ChartSetString.

La fonction est synchrone, ce qui signifie qu'elle attend l'exécution de toutes les commandes qui ont été ajoutées dans la queue des évènements du graphique avant son appel.

Exemple:

void OnStart()
  {
   ChartSetString(0,CHART_COMMENT,"Test comment.\nSecond line.\nThird!");
   ChartRedraw();
   Sleep(1000);
   string comm=ChartGetString(0,CHART_COMMENT);
   Print(comm);
  }

Voir aussi

Comment, ChartSetString