DocumentaçãoSeções
Referência MQL5Biblioteca PadrãoObjetos gráficosCChartObjectGetString 

GetString

Fornece acesso simplificado às funções ObjectGetString() do API MQL5 para as propriedades tipo string, é vinculado a uma instância de classe do objeto gráfico. Existem duas versões de uma chamada desta função:

Obtendo um valor de propriedade, sem verificar a exatidão

string  GetString(
   ENUM_OBJECT_PROPERTY_STRING  prop_id,         // Identifier of string-property
   int                          modifier=-1      // Modifier
   ) const

Parâmetros

prop_id

[in]  Identificador das propriedades tipo string do objeto gráfico.

modifier=-1

[in]  Modificador (indexador) de propriedade tipo string.

Valor do Retorno

Valor da propriedade tipo string.

Obtendo um valor de propriedade ao verificar a correção de tal tratamento

bool  GetString(
   ENUM_OBJECT_PROPERTY_STRING  prop_id,      // Identifier of string-property
   int                          modifier,     // Modifier
   string&                      value         // Link to variable
   ) const

Parâmetros

prop_id

[in]  Identificador das propriedades tipo string do objeto gráfico.

modifier

[in]  Modificador (indexador) de propriedade tipo string.

value

[out]  Referência a uma variável para acomodar as propriedades de valor tipo string.

Valor do Retorno

verdadeiro - se bem sucedido, falso - não é possível obter a propriedade tipo string.

Exemplo

//--- 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); 
     } 
  }