ObjectsDeleteAll

从指定图表中删除所有物件,指定图表子窗口,指定类型。

int  ObjectsDeleteAll(
   long  chart_id,           // 图表标识符
   int   sub_window=-1,      // 窗口索引
   int   type=-1             // 物件类型
   );

使用对象名称的前缀移除所有指定类型的对象。

int  ObjectsDeleteAll(
   long           chart_id,   // 图表标识符
   const string     prefix,   // 对象名称前缀
   int       sub_window=-1,   // 窗口索引
   int      object_type=-1    // 对象类型
   );

参量

chart_id

[in]  图表标识符。0代表当前图表。

prefix

[in] 对象名称前缀:所有名称以这组字符开头的对象都将从图表移除。您可以指定前缀为 'name' 或 'name*' – 两种变量的工作相同。如果空字符串设定为前缀,那么所有可能名称的对象都将被移除。

sub_window=-1

[in] 图表子窗口号码。0代表主要图表窗口,-1代表图表子窗口,包括主窗口。

type=-1

[in]  物件类型。值可以是 ENUM_OBJECT 值中一个,-1表示全部类型。

返回值

返回删除物件的数量。阅读更多关于 错误 信息,调用 GetLastError()

注意

该函数使用同步调用,这意味着这个函数等待执行在调用之前已入列图表的所有命令,这就是该函数耗费时间的原因。当处理图表上的大量对象时应该考虑这个特性。