ChartGetString

Devuelve el valor para la propiedad correspondiente del gráfico especificado. La propiedad del gráfico debe ser del tipo string. Existen 2 variantes de la función.

1. Devuelve el valor de la propiedad directamente.

string  ChartGetString(
   long  chart_id,          // identificador del gráfico
   int   prop_id            // identificador de la propiedad
   );

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

bool  ChartGetString(
   long    chart_id,        // identificador del gráfico
   int     prop_id,         // identificador 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.

prop_id

[in]  Identificador de la propiedad del gráfico. Su valor puede ser uno de los valores de la enumeración ENUM_CHART_PROPERTY_STRING.

string_var

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

Valor devuelto

Valor del tipo string.

En segundo caso devuelve true, si dicha propiedad estça disponible y su valor ha sido pasado en la variable string_var, de lo contrario devuelve false. Para obtener más detalles sobre el error hay que llamar a la función GetLastError().

Nota

La función ChartGetString puede ser usada para leer los comentarios se visualizan en el gráfico usando las funciones Comment o ChartSetString.

La función es sincrónica, esto significa que esperará a que se ejecuten todos los comandos ubicados en la cola del gráfico antes de ser llamada.

Ejemplo:

void OnStart()
  {
   ChartSetString(0,CHART_COMMENT,"Test comment.\nSecond line.\nThird!");
   ChartRedraw();
   Sleep(1000);
   string comm=ChartGetString(0,CHART_COMMENT);
   Print(comm);
  }

Véase también

Comment, ChartSetString