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() を呼びます。

注意事項

この関数は同期呼び出しを使用します。つまり、この関数が呼び出される前にこのチャートのエンキューされたすべてのコマンドの実行が待機されるため、この関数は時間がかかることがあります。チャート上で多数のオブジェクトを操作する場合は、この特徴を考慮する必要があります。