函數(shù)返回相應(yīng)對象屬性的值邻寿。對象屬性必須是字符串類型伯复。這個函數(shù)有兩個變體搞莺。
1。立即返回屬性值疚鲤。
string ObjectGetString(
long chart_id, //圖表標(biāo)識符
string object_name, //對象名稱
int prop_id, //屬性標(biāo)識符
int prop_modifier=0 //如果需要锥累,屬性修飾符
);
2。返回true或false集歇,這取決于函數(shù)是否成功桶略。如果成功,則將屬性值放置到由最后一個參數(shù)引用傳遞的接收變量上诲宇。
bool ObjectGetString(
long chart_id, //圖表標(biāo)識符
string object_name, //對象名稱
int prop_id, //屬性標(biāo)識符
int prop_modifier, //屬性修飾符
string& string_var //這里我們接受屬性值
);
參數(shù)
chart_id
[in]表標(biāo)識符删性。0表示當(dāng)前圖表。
object_name
以物體的名義焕窝。
prop_id
對象屬性的ID蹬挺。該值可以是ENUM_OBJECT_PROPERTY_STRING枚舉的值之一。
prop_modifier
[in]指定屬性的修飾符它掂。對于第一個變量巴帮,默認(rèn)修飾符值為0。大多數(shù)屬性不需要修飾符虐秋。它表示斐波那契工具和圖形對象Andrew的干草叉中級別的數(shù)量榕茧。能級的計算從0開始。
string_var
接收請求屬性值的字符串類型的[out]變量客给。
返回值
調(diào)用的第一個版本的字符串值用押。
對于調(diào)用的第二個版本返回true,如果該屬性得到維護靶剑,并且該值已被放置到string_var變量中蜻拨,則返回false池充。要了解有關(guān)錯誤調(diào)用GetLastError()的更多信息,請參閱缎讼。
請注意
當(dāng)在當(dāng)前圖表上使用此函數(shù)時收夸,將直接訪問此圖表,而為了接收另一個圖表上對象的屬性血崭,將使用同步調(diào)用卧惜。同步調(diào)用意味著函數(shù)在調(diào)用之前等待所有已經(jīng)為這個圖表排隊的命令的執(zhí)行,這就是為什么這個函數(shù)會很耗時夹纫。在處理圖表上的大量對象時咽瓷,應(yīng)該考慮到這個特性。