ChartGetInteger

Restituisce il valore di una proprietà corrispondente del grafico specificato. La proprietà del grafico deve essere di tipo datetime, int o bool. Ci sono 2 varianti di chiamate di funzione.

1. Restituisce il valore della proprietà direttamente.

long  ChartGetInteger(
   long                          chart_id,        // ID del Grafico
   ENUM_CHART_PROPERTY_INTEGER   prop_id,         // ID della Proprietà
   int                           sub_window=0     // numero della sottofinestra, se necessario
   );

2. Restituisce true o false, a seconda se la funzione ha avuto successo. In caso di successo, il valore della proprietà viene posto in una variabile target long_var passata per riferimento.

bool  ChartGetInteger(
   long                          chart_id,        // ID del Grafico
   ENUM_CHART_PROPERTY_INTEGER   prop_id,         // ID della Proprietà
   int                           sub_window,      // numero sottofinestra
   long&                         long_var         // Variabile target per la proprietà
   );

Parametri

chart_id

[in] ID del Grafico. 0 significa il grafico corrente.

prop_id

[in]  ID proprietà del Grafico. Questo valore può essere uno dei valori ENUM_CHART_PROPERTY_INTEGER.

sub_window

[in] Numero di sottofinestra grafico. Per il primo caso, il valore di default è 0 (finestra grafico principale). La maggior parte delle proprietà non richiedono un numero sottofinestra.

long_var

[out] Variabile target di tipo long per la proprietà richiesta.

Valore restituito

Il valore di tipo long.

Per il caso della seconda chiamata restituisce true se la proprietà specificata è disponibile ed il suo valore è stato memorizzato nella variabile long_var, altrimenti restituisce false. Per ottenere ulteriori informazioni sull' errore, è necessario richiamare la funzione GetLastError().

Nota

La funzione è sincrona, il che significa che attende l'esecuzione di tutti i comandi che sono stati aggiunti alla coda del chart prima della sua chiamata.

Esempio:

voidOnStart()
  {
   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");
  }