DocumentationSections
Référence MQL5Bibliothèque StandardObjets GraphiquesCChartObjectGetString 

GetString

Fournit un accès simplifié aux fonctions de l'API MQL5 ObjectGetString() pour récupérer les valeurs de type string de l'objet graphique assigné à l'instance de classe. Deux signatures existent :

Récupérer la valeur de la propriété sans en vérifier l'exactitude

string  GetString(
   ENUM_OBJECT_PROPERTY_STRING  prop_id,         // Identifiant de la propriété de type string
   int                          modifier=-1      // Modificateur
   ) const

Paramètres

prop_id

[in]  Identifiant de la propriété de type string de l'objet.

modifier=-1

[in]  Modificateur (index) de la propriété de type string.

Valeur de Retour

Valeur de la propriété de type string.

Récupérer la valeur de la propriété en vérifiant son exactitude

bool  GetString(
   ENUM_OBJECT_PROPERTY_STRING  prop_id,      // Identifiant de la propriété de type string
   int                          modifier,     // Modificateur
   string&                      value         // Référence vers la variable
   ) const

Paramètres

prop_id

[in]  Identifiant de la propriété de type string de l'objet.

modifier

[in]  Modificateur (index) de la propriété de type string.

value

[out]  Référence à une variable permettant de récupérer la valeur de la propriété.

Valeur de Retour

vrai si réalisé avec succès, faux si l'objet ne peut pas renvoyer une valeur de type string.

Exemple :

//--- exemple d'utilisation de CChartObject::GetString
#include <ChartObjects\ChartObject.mqh> 
//--- 
void OnStart() 
  { 
   CChartObject object; 
   string       value; 
   //--- récupère le nom de l'objet par la méthode simple 
   printf("Object name is '%s'",object.GetString(OBJPROP_NAME)); 
   //--- récupère le nom de l'objet par la méthode classique 
   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++) 
     { 
      //--- récupère la description des niveaux par la méthode simple 
      printf("Level %d description is '%s'",i,object.GetString(OBJPROP_LEVELTEXT,i)); 
      //--- récupère la description des niveaux par la méthode classique 
      if(!object.GetString(OBJPROP_LEVELTEXT,i,value)) 
        { 
         printf("Get string property error %d",GetLastError()); 
         return; 
        } 
      else 
         printf("Level %d description is '%s'",i,value); 
     } 
  }