ObjectGetString

Devuelve el valor de la correspondiente propiedad del objeto. La propiedad del objeto debe ser del tipo string. Existen 2 variantes de la función.

1 Devuelve el valor de la propiedad directamente.

string  ObjectGetString(
   long                            chart_id,          // identificador del gráfico
   string                          name,              // nombre del objeto
   ENUM_OBJECT_PROPERTY_STRING     prop_id,           // identificador de la propiedad
   int                             prop_modifier=0    // modificador de la propiedad, si hace falta
   );

2. Devuelve true o false dependiendo del éxito de ejecución de la función. En caso de éxito el valor de la propiedad se coloca en una variable receptora que se pasa por referencia por el último parámetro.

bool  ObjectGetString(
   long                            chart_id,          // identificador del gráfico
   string                          name,              // nombre del objeto
   ENUM_OBJECT_PROPERTY_STRING     prop_id,           // identificador de la propiedad
   int                             prop_modifier,     // modificador de la propiedad
   string&                         string_var         // aquí recibimos el valor de la propiedad
   );

Parámetros

chart_id

[in]  Identificador del gráfico. 0 significa el gráfico actual.

name

[in]  Nombre del objeto.

prop_id

[in]  Identificador de la propiedad del objeto. Su valor puede ser uno de los valores de la enumeración ENUM_OBJECT_PROPERTY_STRING.

prop_modifier

[in]  Modificador de la propiedad especificada. Para la primera opción el valor del modificador es igual a 0 por defecto. La mayoría de las propiedades no requiere el modificador. Significa el número del nivel en las herramientas de Fibonacci y en el objeto gráfico Tridente de Andrews. La numeración se empieza desde cero.

string_var

[out]  Variable del tipo string que recibe el valor de la propiedad requerida.

Valor devuelto

Valor del tipo string para la primera opción de la llamada.

Para la segunda variante devuelve true, si dicha propiedad se mantiene y su valor ha sido colocado en la variable string_var, de lo contrario devuelve false. Para la información más detallada sobre el error hay que llamar a la función GetLastError().

Nota

La función usa una llamada sincrónica, esto significa que la función espera a la ejecución de todos los comandos que han sido ubicados en la cola del gráfico antes de su llamada, y por eso puede consumir un tiempo considerable. Hay que tener esta circunstancia en cuenta al trabajar con multitud de objetos en el gráfico.

Al renombrar un objeto gráfico, se generan al mismo tiempo dos eventos que pueden ser procesados en el Asesor Experto o el indicador usando la función OnChartEvent():

  • evento de eliminación del objeto con el nombre anterior;
  • evento de creación del objeto gráfico con el nombre nuevo.