Справочник MQL5Операции с графикамиChartGetString

ChartGetString

Возвращает значение соответствующего свойства указанного графика. Свойство графика должно быть типа string. Существует 2 варианта функции.

1. Непосредственно возвращает значение свойства.

string  ChartGetString(
   long  chart_id,                                 // идентификатор графика
   ENUM_CHART_PROPERTY_STRING   prop_id            // идентификатор свойства
   );

2. Возвращает true или false в зависимости от успешности выполнения функции. В случае успеха значение свойства помещается в приемную переменную, передаваемую по ссылке последним параметром.

bool  ChartGetString(
   long    chart_id,                               // идентификатор графика
   ENUM_CHART_PROPERTY_STRING     prop_id,         // идентификатор свойства
   string& string_var                              // сюда примем значение свойства
   );

Параметры

chart_id

[in] Идентификатор графика. 0 означает текущий график.

prop_id

[in] Идентификатор свойства графика. Значение может быть одним из значений перечисления ENUM_CHART_PROPERTY_STRING.

string_var

[out] Переменная типа string, принимающая значение запрашиваемого свойства.

Возвращаемое значение

Значение типа string.

Для второго варианта вызова возвращает true, если данное свойство поддерживается и значение было помещено в переменную string_var, иначе возвращает false. Чтобы получить дополнительную информацию об ошибке, необходимо вызвать функцию GetLastError().

Примечание

Функция ChartGetString может использоваться для считывания комментариев, выведенных на график функциями Comment или ChartSetString.

Функция является синхронной – это означает, что она дожидается выполнения всех команд, которые были помещены в очередь графика перед её вызовом.

Пример:

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

Смотри также

Comment, ChartSetString

ChartGetInteger

ChartNavigate