函数返回相应对象属性的值。对象属性必须是字符串类型。这个函数有两个变体。
1。立即返回属性值。
string ObjectGetString(
long chart_id, //图表标识符
string object_name, //对象名称
int prop_id, //属性标识符
int prop_modifier=0 //如果需要,属性修饰符
);
2。返回true或false,这取决于函数是否成功。如果成功,则将属性值放置到由最后一个参数引用传递的接收变量上。
bool ObjectGetString(
long chart_id, //图表标识符
string object_name, //对象名称
int prop_id, //属性标识符
int prop_modifier, //属性修饰符
string& string_var //这里我们接受属性值
);
参数
chart_id
[in]表标识符。0表示当前图表。
object_name
以物体的名义。
prop_id
对象属性的ID。该值可以是ENUM_OBJECT_PROPERTY_STRING枚举的值之一。
prop_modifier
[in]指定属性的修饰符。对于第一个变量,默认修饰符值为0。大多数属性不需要修饰符。它表示斐波那契工具和图形对象Andrew的干草叉中级别的数量。能级的计算从0开始。
string_var
接收请求属性值的字符串类型的[out]变量。
返回值
调用的第一个版本的字符串值。
对于调用的第二个版本返回true,如果该属性得到维护,并且该值已被放置到string_var变量中,则返回false。要了解有关错误调用GetLastError()的更多信息,请参阅。
请注意
当在当前图表上使用此函数时,将直接访问此图表,而为了接收另一个图表上对象的属性,将使用同步调用。同步调用意味着函数在调用之前等待所有已经为这个图表排队的命令的执行,这就是为什么这个函数会很耗时。在处理图表上的大量对象时,应该考虑到这个特性。