Справочник по языку программирования MQL5

Подождите немного. Документ загружается.

Стандартная библиотека

1601

GetInteger

Возвращает значение соответствующего свойства указанного графика. Свойство графика должно

быть типа integer. Существует 2 варианта функции.

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

long GetInteger(

ENUM_CHART_PROPERTY_INTEGER prop_id, // идентификатор свойства

int sub_window=0 // номер подокна

) const

2. Помещает значение свойства в приемную переменную, передаваемую по ссылке последним

параметром, в случае успеха.

bool GetInteger(

ENUM_CHART_PROPERTY_INTEGER prop_id, // идентификатор свойства

int sub_window, // номер подокна

long& value // ссылка на переменную

) const

Параметры

prop_id

[in] Идентификатор свойства графика (из перечисления ENUM_CHART_PROPERTY_INTEGER).

sub_window

[in] Номер подокна графика.

value

[in] Ссылка на переменную, принимающую значение запрашиваемого свойства.

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

Значение свойства графика, привязанного к экземпляру класса. Если нет привязанного

графика, возвращается -1.

Для второго варианта вызова возвращает true, если данное свойство поддерживается и

значение было помещено в переменную value, иначе возвращает false. Чтобы получить

дополнительную информацию об ошибке, необходимо вызвать функцию GetLastError().

Стандартная библиотека

1602

SetInteger

Устанавливает значение integer-свойства графика.

bool SetInteger(

ENUM_CHART_PROPERTY_INTEGER prop_id, // идентификатор свойства

long value // значение

)

Параметры

prop_id

[in] Идентификатор свойства графика (из перечисления ENUM_CHART_PROPERTY_INTEGER).

value

[in] Новое значение свойства.

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

true – в случае удачи, false – если не удалось изменить integer-свойство.

Стандартная библиотека

1603

GetDouble

Возвращает значение соответствующего свойства указанного графика. Свойство графика должно

быть типа double. Существует 2 варианта функции.

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

double GetDouble(

ENUM_CHART_PROPERTY_DOUBLE prop_id, // идентификатор свойства

int sub_window=0 // номер подокна

) const

2. Помещает значение свойства в приемную переменную, передаваемую по ссылке последним

параметром, в случае успеха.

bool GetDouble(

ENUM_CHART_PROPERTY_DOUBLE prop_id, // идентификатор свойства

int sub_window, // номер подокна

double& value // ссылка на переменную

) const

Параметры

prop_id

[in] Идентификатор свойства графика (из перечисления ENUM_CHART_PROPERTY_DOUBLE).

sub_window

[in] Номер подокна графика.

value

[in] Ссылка на переменную, принимающую значение запрашиваемого свойства.

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

Значение свойства графика, привязанного к экземпляру класса. Если нет привязанного

графика, возвращается EMPTY_VALUE.

Для второго варианта вызова возвращает true – в случае удачи, false – если не удалось получить

значение свойства. Чтобы получить дополнительную информацию об ошибке, необходимо

вызвать функцию GetLastError().

Стандартная библиотека

1604

SetDouble

Устанавливает значение double-свойства графика.

bool SetDouble(

ENUM_CHART_PROPERTY_DOUBLE prop_id, // идентификатор свойства

double value // значение

)

Параметры

prop_id

[in] Идентификатор свойства графика (из перечисления ENUM_CHART_PROPERTY_DOUBLE).

value

[in] Новое значение свойства.

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

true – в случае удачи, false – если не удалось изменить double-свойство.

Стандартная библиотека

1605

GetString

Возвращает значение соответствующего свойства указанного графика. Свойство графика должно

быть типа string. Существует 2 варианта функции.

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

string GetString(

ENUM_CHART_PROPERTY_STRING prop_id // идентификатор свойства

) const

2. Помещает значение свойства в приемную переменную, передаваемую по ссылке последним

параметром, в случае успеха.

bool GetString(

ENUM_CHART_PROPERTY_STRING prop_id, // идентификатор свойства

string& value // ссылка на переменную

) const

Параметры

prop_id

[in] Идентификатор свойства графика (из перечисления ENUM_CHART_PROPERTY_STRING).

value

[in] Ссылка на переменную, принимающую значение запрашиваемого свойства.

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

Значение свойства графика, привязанного к экземпляру класса. Если нет привязанного

графика, возвращается "".

Для второго варианта вызова возвращает true, если данное свойство поддерживается и

значение было помещено в переменную value, иначе возвращает false. Чтобы получить

дополнительную информацию об ошибке, необходимо вызвать функцию GetLastError().

Стандартная библиотека

1606

SetString

Устанавливает значение string-свойства графика.

bool SetString(

ENUM_CHART_PROPERTY_STRING prop_id, // идентификатор свойства

string value // значение

)

Параметры

prop_id

[in] Идентификатор свойства графика (из перечисления ENUM_CHART_PROPERTY_STRING).

value

[in] Новое значение свойства.

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

true – в случае удачи, false – если не удалось изменить string-свойство.

Стандартная библиотека

1607

SetSymbolPeriod

Изменяет символ и период графика, привязанного к экземпляру класса.

bool SetSymbolPeriod(

const string symbol_name, // инструмент

ENUM_TIMEFRAMES timeframe // период

)

Параметры

symbol_name

[in] Новый символ графика. NULL oзначает символ текущего графика (к которому прикреплен

эксперт).

timeframe

[in] Новый период графика (из перечисления ENUM_TIMEFRAMES). 0 означает период

текущего графика.

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

true – в случае удачи, false – если не удалось изменить свойства.

Стандартная библиотека

1608

ApplyTemplate

Применяет к графику указанный шаблон.

bool ApplyTemplate(

const string filename // шаблон

)

Параметры

filename

[in] Имя файла, содержащего шаблон.

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

true – в случае удачи, false – если не удалось применить шаблон.

Стандартная библиотека

1609

ScreenShot

Обеспечивает скриншот указанного графика в его текущем состоянии в формате gif.

bool ScreenShot(

string filename, // имя файла

int width, // ширина

int height, // высота

ENUM_ALIGN_MODE align_mode=ALIGN_RIGHT // тип выравнивания

) const

Параметры

filename

[in] Имя файла скриншота.

width

[in] Ширина скриншота в пикселях.

height

[in] Высота скриншота в пикселях.

align_mode=ALIGN_RIGHT

[in] Режим вывода узкого скриншота.

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

true в случае успеха, иначе false.

Стандартная библиотека

1610

WindowOnDropped

Получает номер подокна графика, на которое брошен мышкой данный эксперт или скрипт.

int WindowOnDropped() const

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

Номер подокна графика, на которое брошен мышкой данный эксперт или скрипт. 0 означает

главное окно графика.