ChartGetInteger

Rend la valeur de la propriété correspondante du graphique indiqué. La propriété du graphique doit être des types datetime, int ou bool. Il y a 2 variantes de la fonction.

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

long  ChartGetInteger(
   long                          chart_id,        // identificateur du graphique
   ENUM_CHART_PROPERTY_INTEGER   prop_id,         // identificateur de la propriété
   int                           sub_window=0     // numéro de la sous-fenêtre, si c'est nécessaire
   );

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  ChartGetInteger(
   long                          chart_id,        // identificateur du graphique
   ENUM_CHART_PROPERTY_INTEGER   prop_id,         // identificateur de la propriété
   int                           sub_window,      // numéro de la sous-fenêtre
   long&                         long_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_INTEGER.

sub_window

[in]  Pour la première variante la valeur est égale à 0 par défaut (une fenêtre principale du graphique). La plupart des propriétés ne demandent pas l'indication du numéro de la sous-fenêtre.

long_var

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

La valeur rendue

La valeur du type long.

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 long_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 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()
  {
   int height=ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0);
   int width=ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0);
   Print("CHART_HEIGHT_IN_PIXELS = ",height," pixels");
   Print("CHART_WIDTH_IN_PIXELS = ",width," pixels");
  }