ChartGetInteger
ChartGetInteger
返回指定图表相关属性值。图表属性必须是日期时间,整型,布尔型类型。有两种函数调用变体。
- 直接返回属性值。
long ChartGetInteger(
long chart_id, // 图表 ID
ENUM_CHART_PROPERTY_INTEGER prop_id, // 属性 ID
int sub_window=0 // 子窗口号,如果需要的话
);- 按照函数成功与否,返回 true 或者 false。如果成功,属性值置于引用传递的目标变量long_var。
bool ChartGetInteger(
long chart_id, // 图表 ID
ENUM_CHART_PROPERTY_INTEGER prop_id, // 属性 ID
int sub_window, // 子窗口号
long& long_var // 属性目标值
);参量
- chart_id
[in] 图表 ID. 0 意味着当前图表。
- prop_id
[in] 图表属性 ID. 该值可以是 ENUM_CHART_PROPERTY_INTEGER 值中的一个。
- sub_window
[in] 图表子窗口数。对于第一种情况,默认值为0(图表主窗口)。属性大部分情况都不需要子窗口数。
- long_var
[out] 请求属性的长整型目标变量。
返回值
长整型值。
对于第二种情况,如果指定属性有效并且其值存储在long_var变量中,则返回true,否则返回false。若获得额外错误信息,需要调用 GetLastError()函数。
注意
该函数为同步函数,这意味着它等待执行在其调用之前已添加到图表队列的所有命令。
示例:
void OnStart()
{
int height=ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0);
int width=ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0);
Print("CHART_HEIGHT_IN_PIXELS =",height,"pixels");
Print("CHART_WIDTH_IN_PIXELS =",width,"pixels");
}