ChartGetString
ChartGetString
返回指定图表的相关属性值。图表属性必须是字符串型。有两个函数调用变体。
- 直接返回属性值。
string ChartGetString(
long chart_id, // 图表 ID
ENUM_CHART_PROPERTY_STRING prop_id // 属性 ID
);- 按照函数成功与否,返回true或者false。如果成功,属性值置于引用传递的目标变量string_var。
bool ChartGetString(
long chart_id, // 图表 ID
ENUM_CHART_PROPERTY_STRING prop_id, // 属性 ID
string& string_var // 属性目标值
);参数
- chart_id
[in] 图表 ID. 0 意味着当前图表。
- prop_id
[in] 图表属性 ID。该值可以是 ENUM_CHART_PROPERTY_STRING 值中的一个。
- string_var
[out] 请求属性字符串类型的目标变量。
返回值
字符串类型值。
对于第二种调用情况,如果指定属性有效并且其值存储在string_var变量中返回true,否则返回 false。若要获得额外错误信息,需要调用GetLastError()函数。
注释
ChartGetString 可以使用注释或者ChartSetString函数用来读取图表中标绘的注释。
该函数为同步函数,这意味着它等待执行在其调用之前已添加到图表队列的所有命令。
示例:
void OnStart()
{
ChartSetString(0,CHART_COMMENT,"Test comment.\nSecond line.\nThird!");
ChartRedraw();
Sleep(1000);
string comm=ChartGetString(0,CHART_COMMENT);
Print(comm);
}