Русский

Справочник MQL4 Графические объекты ObjectGetString

ObjectGetString

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

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

string  ObjectGetString(
   long     chart_id,         // идентификатор графика
   string   object_name,      // имя объекта
   int      prop_id,          // идентификатор свойства
   int      prop_modifier=0   // модификатор свойства, если требуется
   );

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

bool  ObjectGetString(
   long      chart_id,        // идентификатор графика
   string    object_ame,      // имя объекта
   int       prop_id,         // идентификатор свойства
   int       prop_modifier,   // модификатор свойства
   string&   string_var       // сюда примем значение свойства
   );

Параметры

chart_id

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

object_name

[in]  Имя объекта.

prop_id

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

prop_modifier

[in]  Модификатор указанного свойства. Для первого варианта по умолчанию значение модификатора равно 0. Большинство свойств не требуют модификатора. Означает номер уровня в инструментах Фибоначчи и в графическом объекте Вилы Эндрюса. Нумерация уровней начинается с нуля.

string_var

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

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

Значение типа string для первого варианта вызова.

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

Примечание

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