ObjectGetDouble

此函数返回相应对象属性的值。该对象属性必须是双精度浮点数类型。该函数有两种实现方式。

1. 立即返回属性值。

double  ObjectGetDouble(
   long     chart_id,         // chart identifier
   string   object_name,      // object name
   int      prop_id,          // property identifier
   int      prop_modifier=0   // property modifier, if required
   );

2. 根据函数的执行结果返回 true 或 false。如果成功，属性值将通过引用传递给最后一个参数所指定的接收变量。

bool  ObjectGetDouble(
   long      chart_id,        // chart identifier
   string    object_name,     // object name
   int       prop_id,         // property identifier
   int       prop_modifier,   // property modifier
   double&   double_var       // here we accept the property value
   );

参数

chart_id

[输入] 图表标识符。0表示当前图表。

object_name

[输入] 对象的名称。

prop_id

[输入] 对象属性的ID。ENUM_OBJECT_PROPERTY_DOUBLE枚举中的值之一。

prop_modifier

[输入] 指定属性的修饰符。对于第一种实现方式，默认修饰符值为0。大多数属性不需要修饰符。它表示在斐波那契工具和图形对象Andrew的叉状图中的层级编号。层级编号从零开始。

double_var

[输出] 接收所需属性值的双精度浮点数类型的变量。

返回值

对于第一种调用方式，返回双精度浮点数类型的值。

对于第二种实现方式，如果此属性存在且值已存储在double_var变量中，则函数返回true；否则返回false。要了解更多关于错误的信息，请调用GetLastError()。

注意

当此函数用于当前图表时，直接访问该图表；而为了获取不同图表上对象的属性，则需要使用同步调用。同步调用意味着函数在调用之前会等待所有已排队到该图表的命令执行完毕，因此此函数可能会耗时较长。在处理图表上大量对象时，应考虑这一特性。