ChartGetString

Retorna o valor de uma propriedade correspondente do gráfico especificado. Propriedade de Gráfico deve ser do tipo string. Existem duas variantes das chamadas desta função.

1. Retorna diretamente o valor da propriedade.

string  ChartGetString(
   long  chart_id,          // ID Gráfico
   int   prop_id            // ID Propriedade
   );

2. Retorna true ou false, dependendo do sucesso na execução da função. Se for bem sucedido, o valor da propriedade é colocado num alvo variável string_var passado como referência.

bool  ChartGetString(
   long    chart_id,        // ID Gráfico
   int     prop_id,         // ID Propriedade
   string& string_var       // Alvo variável para a propriedade
   );

Parâmetros

chart_id

[in]  ID Gráfico. Significa o gráfico atual.

prop_id

[in]  ID Propriedade do gráfico. Este valor pode ser um dos valores ENUM_CHART_PROPERTY_STRING.

string_var

[out]  Alvo variável do tipo string para a propriedade solicitada.

Valor do Retorno

Valor de tipo string.

Para a segunda chamada caso retorne true se a propriedade especificada está disponível e seu valor foi armazenado dentro da variável string_var, caso contrário retorna false. Para obter uma informação adicional sobre o error, é necessário chamar a função GetLastError().

Observação

ChartGetString pode ser usado para leitura dos comentários plotados no gráfico usando funções Comment ou ChartSetString.

A função é síncrona, isto é, ela espera a execução de todos os comandos, que foram colocados na fila do gráfico antes de serem chamados.

Exemplo:

void OnStart()
  {
   ChartSetString(0,CHART_COMMENT,"Comentário de teste.\nSegunda linha.\nTerceira!");
   ChartRedraw();
   Sleep(1000);
   string comm=ChartGetString(0,CHART_COMMENT);
   Print(comm);
  }

Também Veja

Comment, ChartSetString