ObjectGetInteger

A função retorna o valor da propriedade do objeto correspondente. A propriedade do objeto deve ser do tipo datetime, int, color, bool ou char. Existem 2 variantes da função.

1. Imediatamente retorna o valor da propriedade.

long  ObjectGetInteger(
   long                             chart_id,          // identificador Gráfico
   string                           name,              // nome objeto
   ENUM_OBJECT_PROPERTY_INTEGER     prop_id,           // identificador propriedade
   int                              prop_modifier=0    // modificador de propriedade, se requerida
   );

2. Retorna true ou false, dependendo do sucesso da função. Se bem sucedido, o valor da propriedade é colocado para receber uma variável passada como referência pelo último parâmetro.

bool  ObjectGetInteger(
   long                             chart_id,          // identificador Gráfico
   string                           name,              // nome objeto
   ENUM_OBJECT_PROPERTY_INTEGER     prop_id,           // identificador propriedade
   int                              prop_modifier,     // modificador propriedade
   long&                            long_var           // aqui nós aceitamos o valor da propriedade
   );

Parâmetros

chart_id

[in]  Identificador do gráfico. Significa o gráfico atual.

nome

[in]  Nome do objeto.

prop_id

[in]  ID da propriedade do objeto. O valor pode ser um dos valores do enumerador ENUM_OBJECT_PROPERTY_INTEGER.

prop_modifier

[in]  Modificador da propriedade específica. Para a primeira variante, o modificador tem valor padrão igual a 0. A maioria das propriedades não requerem um modificador. Indica o número do nível em ferramentas Fibonacci e no objeto gráfico do tipo Tridente de Andrew. A numeração dos níveis começa a partir do zero.

long_var

[out]  Variável do tipo long que recebe o valor da propriedade requisitada.

Valor do Retorno

O valor long para a primeira chamada da variante.

A função retorna true para a segunda variante, se essa propriedade for mantida e o valor foi colocado na variável long_var, caso contrário, retorna false. Para ler mais sobre o erro, chamar GetLastError().

Observação

A função utiliza uma chamada síncrona, isso significa que a função espera a execução de todos os comandos que foram colocados na fila do gráfico antes de sua chamada, e por isso este recurso pode consumir muito tempo. Deve ter isso em mente, se você estiver trabalhando com um grande número de objetos no gráfico.