ДокументацияРазделы
Справочник MQL5Стандартная библиотекаГрафические объектыБазовый класс CChartObjectGetString 

GetString

Обеспечивает упрощенный доступ к функциям API MQL5 ObjectGetString() для получения значений string-свойств, привязанного к экземпляру класса графического объекта.  Существуют два варианта вызова функции:

Получение значения свойства без проверки корректности

string  GetString(
   ENUM_OBJECT_PROPERTY_STRING  prop_id,         // идентификатор string-свойства
   int                          modifier=-1      // модификатор 
   ) const

Параметры

prop_id

[in]  Идентификатор string-свойства графического объекта.

modifier=-1

[in]  Модификатор (индекс) string-свойства.

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

Значение string-свойства – в случае удачи, "" - если нет возможности получить string-свойство.

Получение значения свойства с проверкой корректности такого обращения

bool  GetString(
   ENUM_OBJECT_PROPERTY_STRING  prop_id,      // идентификатор string-свойства
   int                          modifier,     // модификатор 
   string&                      value         // ссылка на переменную 
   ) const

Параметры

prop_id

[in]  Идентификатор string-свойства графического объекта.

modifier

[in]  Модификатор (индекс) string-свойства.

value

[out]  Ссылка на переменную для размещения значения string-свойства.

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

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

Пример:

//--- example for CChartObject::GetString 
#include <ChartObjects\ChartObject.mqh> 
//--- 
void OnStart() 
  { 
   CChartObject object; 
   string       value; 
   //--- get name of chart object by easy method 
   printf("Object name is '%s'",object.GetString(OBJPROP_NAME)); 
   //--- get name of chart object by classic method 
   if(!object.GetString(OBJPROP_NAME,0,value)) 
     { 
      printf("Get string property error %d",GetLastError()); 
      return; 
     } 
   else 
      printf("Object name is '%s'",value); 
   for(int i=0;i<object.LevelsCount();i++) 
     { 
      //--- get levels description by easy method 
      printf("Level %d description is '%s'",i,object.GetString(OBJPROP_LEVELTEXT,i)); 
      //--- get levels description by classic method 
      if(!object.GetString(OBJPROP_LEVELTEXT,i,value)) 
        { 
         printf("Get string property error %d",GetLastError()); 
         return; 
        } 
      else 
         printf("Level %d description is '%s'",i,value); 
     } 
  }