ChartGetInteger

Retorna o valor de uma propriedade correspondente do gráfico especificado. Propriedade do gráfico é obrigatório ser do tipo datetime, int ou bool . Existem duas variantes das chamadas desta função.

1. Retorna diretamente o valor da propriedade.

long  ChartGetInteger(
   long  chart_id,          // ID Gráfico
   int   prop_id,           // ID Propriedade
   int   sub_window=0       // número da sub-janela, se necessário
   );

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 long_var passado como referência.

bool  ChartGetInteger(
   long    chart_id,        // ID Gráfico
   int     prop_id,         // ID Propriedade
   int     sub_window,      // Número da sub-janela
   long&   long_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_INTEGER.

sub_window

[in]  Número de sub-janela do gráfico. Para o primeiro caso, o valor padrão é 0 (janela do gráfico principal). A maioria das propriedades não requerem uma número de sub-janela.

long_var

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

Valor do Retorno

Valor de tipo long.

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

Observação

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()
  {
   int height=ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0);
   int width=ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0);
   Print("CHART_HEIGHT_IN_PIXELS =",height,"pixels");
   Print("CHART_WIDTH_IN_PIXELS =",width,"pixels");
  }