跳至内容

ObjectGetString

ObjectGetString

此函数返回相应对象属性的值。该对象属性必须是字符串类型。该函数有两种变体。

  1. 立即返回属性值。
string  ObjectGetString(
   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  ObjectGetString(
   long    chart_id,          // chart identifier
   string  object_name,       // object name
   int     prop_id,           // property identifier
   int     prop_modifier,     // property modifier
   string& string_var         // here we accept the property value
   );

参数

chart_id

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

object_name

[输入] 对象的名称。

prop_id

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

prop_modifier

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

string_var

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

返回值

对于第一次调用,返回字符串值。

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

注意

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

最后更新于