跳至内容

ObjectGetInteger

ObjectGetInteger

此函数返回相应对象属性的值。该对象属性必须是datetime、int、color、bool或char类型。该函数有两种变体。

  1. 立即返回属性值。
long  ObjectGetInteger(
   long     chart_id,         // chart identifier
   string   object_name,      // object name
   int      prop_id,          // property identifier
   int      prop_modifier=0   // property modifier, if required
   );
  1. 根据函数的成功与否返回true或false。如果成功,属性值将通过最后一个参数引用的方式被传递给接收变量。
bool  ObjectGetInteger(
   long     chart_id,         // chart identifier
   string   object_name,      // object name
   int      prop_id,          // property identifier
   int      prop_modifier,    // property modifier
   long&    long_var          // here we accept the property value
   );

参数

chart_id

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

object_name

[输入] 对象名称。

prop_id

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

prop_modifier

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

long_var

[输出] 接收所需属性值的长类型变量。

返回值

对于第一种调用变体,返回长类型值。

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

注意

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

最后更新于