ChartGetString

Restituisce il valore di una proprietà corrispondente del grafico specificato. Proprietà del grafico deve essere di tipo stringa. Ci sono 2 varianti della chiamata di funzione.

1. Restituisce il valore della proprietà direttamente.

string  ChartGetString(
   long                         chart_id,        // ID del Grafico
   ENUM_CHART_PROPERTY_STRING   prop_id          // ID della Proprietà
   );

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 string_var passata per riferimento.

bool  ChartGetString(
   long                         chart_id,        // ID del Grafico
   ENUM_CHART_PROPERTY_STRING   prop_id,         // ID della Proprietà
   string&                      string_var       // Variable 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_STRING.

string_var

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

Valore restituito

Il valore di tipo stringa.

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

Nota

ChartGetString può essere usato per leggere commenti riportato nel diagramma utilizzando le funzioni Comment o ChartSetString.

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:

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

Vedi anche

Comment, ChartSetString