ChartGetString

Gibt den Wert der entsprechenden Eigenschaft des angegebenen Charts zurück. Die Eigenschaft des Charts muss des Typs string sein. Es gibt  2 Varianten der Funktion.

1. Gibt den Wert der Eigenschaft direkt zurück.

string  ChartGetString(
   long                         chart_id,        // Identifikator des Charts
   ENUM_CHART_PROPERTY_STRING   prop_id          // Identifikator der Eigenschaft
   );

2. Gibt true oder false zurück, abhängig von der erfolgreichen Durchführung der Funktion. Im Erfolgsfall wird der Wert der Eigenschaft in die Empfangsvariable gestellt, die durch Referenz vom letzten Parameter übertragen wird.

bool  ChartGetString(
   long                         chart_id,        // Identifikator des Charts
   ENUM_CHART_PROPERTY_STRING   prop_id,         // Identifikator der Eigenschaft
   string&                      string_var       // hier erhalten wir den Wert der Eigenschaft 
   );

Parameter

chart_id

[in]  Identifikator des Charts. 0 bedeutet den laufenden Chart.

prop_id

[in]  Identifikator der Eigenschaft des Charts. Wert kann einer der Enumerationswerte ENUM_CHART_PROPERTY_STRING sein.

string_var

[out]  Variable des Typs string, die den Wert der angeforderten Eigenschaft annimmt.

Rückgabewert

Wert des Typs string.

für die zweite Variante des Ausrufes gibt true zurück, wenn diese Eigenschaft zugaenglich wird und der Wert in der Variable string_var aufbewahren wird, anderenfalls gibt false zurück. Für die Erhaltung der weiteren Information über den Fehler, muss die Funktion GetLastError() aufgerufen werden.

Hinweis

Funktion ChartGetString kann für Einlesen der Kommentare verwendet werden, die durch die FunktionenComment oder ChartSetString ausgegeben werden.

Diese Funktion ist synchron, das bedeutet, dass sie erst nach der Ausführung aller Befehle ausgeführt wird, die vor dem Aufruf der Funktion zur Warteschlange des Charts hinzugefügt wurden.

Beispiel:

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

Sehen Sie auch

Comment, ChartSetString