ObjectDelete関数の働き・役割
ObjectDelete関数は、指定したチャート上のオブジェクトを削除するために使用されます。チャート上に作成されたラインやテキスト、シンボル(特定の文字や記号)などのオブジェクトを削除する際に利用されます。
ObjectDelete関数の引数について
ObjectDelete関数の引数構成は以下の通りです。
書式
bool ObjectDelete(
long chart_id, // チャートの識別子
string name // オブジェクトの名前
);
引数の詳細
- chart_id: チャートの識別子を指定します。0を指定すると現在アクティブなチャートが対象になります。
- name: 削除するオブジェクトの名前を指定します。オブジェクトの名前はチャート上で一意(1つしか存在しない)の識別子となります。
ObjectDelete関数の戻り値について
ObjectDelete関数は、オブジェクトの削除に成功するとtrueを返し、失敗するとfalseを返します。削除に失敗する場合は、指定したオブジェクトが存在しないか、他のエラーが発生した可能性があります。
ObjectDelete関数を使う際の注意点
ObjectDelete関数では常に非同期呼び出し(関数が呼ばれた後にすぐに処理が戻り、実行結果を待たない方法)が使用されます。
そのため、この関数はチャートキュー(処理待ちの命令リスト)にコマンドを追加した結果だけを返します。trueが返される場合はコマンドが正常にエンキュー(命令リストに追加)されたことを意味し、その実行結果は不明です。
コマンドの実行結果を確認するには、ObjectFind関数またはオブジェクトプロパティをリクエストするObjectGetXXX関数などを使用できます。
しかし、これらの関数もチャートキューの最後に追加されるため、結果を待つ必要があり、時間がかかる場合があります。特にチャート上で多数のオブジェクトを操作する場合は、この特徴を考慮する必要があります。
オブジェクトの名称が変更された場合、次の2つのイベントが同時に発生します。
- 古い名称のオブジェクトの削除イベント
- 新しい名称のオブジェクトの作成イベント
これらのイベントはエキスパートアドバイザーまたはインジケータのOnChartEvent関数によって処理されます。
ObjectDelete関数を使ったサンプルコード
以下はObjectDelete関数を使ったサンプルコードの1例です。このコードではEventChartCustom関数を使用してカスタムイベントを生成し、イベントハンドラーで処理を行っています。
その過程でObjectDelete関数でオブジェクト削除処理を行っています。
string buttonID="Button"; // ボタンオブジェクトの識別子
string labelID="Info"; // ラベルオブジェクトの識別子
int broadcastEventID=5000; // ブロードキャストイベントの識別子
//+------------------------------------------------------------------+
//| エキスパート初期化に使用される関数 |
//+------------------------------------------------------------------+
int OnInit()
{
//--- カスタムイベントを送信するボタンを作成する
ObjectCreate(0,buttonID,OBJ_BUTTON,0,100,100); // ボタンオブジェクトの作成
ObjectSetInteger(0,buttonID,OBJPROP_COLOR,clrWhite); // ボタンの文字色を設定
ObjectSetInteger(0,buttonID,OBJPROP_BGCOLOR,clrGray); // ボタンの背景色を設定
ObjectSetInteger(0,buttonID,OBJPROP_XDISTANCE,100); // ボタンのX座標を設定
ObjectSetInteger(0,buttonID,OBJPROP_YDISTANCE,100); // ボタンのY座標を設定
ObjectSetInteger(0,buttonID,OBJPROP_XSIZE,200); // ボタンの幅を設定
ObjectSetInteger(0,buttonID,OBJPROP_YSIZE,50); // ボタンの高さを設定
ObjectSetString(0,buttonID,OBJPROP_FONT,"Arial"); // ボタンのフォントを設定
ObjectSetString(0,buttonID,OBJPROP_TEXT,"Button"); // ボタンのテキストを設定
ObjectSetInteger(0,buttonID,OBJPROP_FONTSIZE,10); // ボタンのフォントサイズを設定
ObjectSetInteger(0,buttonID,OBJPROP_SELECTABLE,0); // ボタンが選択可能かどうかを設定
//--- 情報を表示するラベルを作成する
ObjectCreate(0,labelID,OBJ_LABEL,0,100,100); // ラベルオブジェクトの作成
ObjectSetInteger(0,labelID,OBJPROP_COLOR,clrRed); // ラベルの文字色を設定
ObjectSetInteger(0,labelID,OBJPROP_XDISTANCE,100); // ラベルのX座標を設定
ObjectSetInteger(0,labelID,OBJPROP_YDISTANCE,50); // ラベルのY座標を設定
ObjectSetString(0,labelID,OBJPROP_FONT,"Trebuchet MS"); // ラベルのフォントを設定
ObjectSetString(0,labelID,OBJPROP_TEXT,"No information"); // ラベルのテキストを設定
ObjectSetInteger(0,labelID,OBJPROP_FONTSIZE,20); // ラベルのフォントサイズを設定
ObjectSetInteger(0,labelID,OBJPROP_SELECTABLE,0); // ラベルが選択可能かどうかを設定
return(INIT_SUCCEEDED); // 初期化成功を返す
}
//+------------------------------------------------------------------+
//| エキスパート初期化解除に使用される関数 |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- ボタンとラベルを削除する
ObjectDelete(0,buttonID); // ボタンオブジェクトの削除
ObjectDelete(0,labelID); // ラベルオブジェクトの削除
}
//+------------------------------------------------------------------+
//| エキスパートティック関数 |
//+------------------------------------------------------------------+
void OnTick()
{
//---
}
//+------------------------------------------------------------------+
//| チャートイベントを処理する関数 |
//+------------------------------------------------------------------+
void OnChartEvent(const int id, const long &lparam, const double &dparam, const string &sparam)
{
//--- マウスボタンを押してイベントをチェックする
if(id==CHARTEVENT_OBJECT_CLICK)
{
string clickedChartObject=sparam; // クリックされたオブジェクトの名前を取得
//--- buttonID の名称のオブジェクトをクリックした場合
if(clickedChartObject==buttonID)
{
//--- ボタンの状態—押されたか放された
bool selected=ObjectGetInteger(0,buttonID,OBJPROP_STATE); // ボタンの状態を取得
//--- デバッグメッセージをログする
Print("Button pressed = ",selected); // ボタンが押されたかどうかをログに出力
int customEventID; // 送信するカスタムイベントのID
string message; // イベントで送られるメッセージ
//--- ボタンが押された場合
if(selected)
{
message="Button pressed"; // メッセージを設定
customEventID=CHARTEVENT_CUSTOM+1; // カスタムイベントIDを設定
}
else // ボタンが押されていない場合
{
message="Button is not pressed"; // メッセージを設定
customEventID=CHARTEVENT_CUSTOM+999; // カスタムイベントIDを設定
}
//--- カスタムイベントを「自分の」チャートに送る
EventChartCustom(0,customEventID-CHARTEVENT_CUSTOM,0,0,message); // カスタムイベントを送信
//--- メッセージを全てのチャートに送る
BroadcastEvent(ChartID(),0,"Broadcast Message"); // 全てのチャートにイベントを送信
//--- デバッグメッセージ
Print("Sent an event with ID = ",customEventID); // 送信したイベントIDをログに出力
}
ChartRedraw(); // チャートオブジェクトの強制再描画
}
//--- イ
ベントがユーザイベントかどうかチェックする
if(id>CHARTEVENT_CUSTOM)
{
if(id==broadcastEventID)
{
Print("Got broadcast message from a chart with id = "+lparam); // ブロードキャストメッセージを受信したことをログに出力
}
else
{
//--- イベントのテキストメッセージを読む
string info=sparam; // イベントのメッセージを取得
Print("Handle the user event with the ID = ",id); // ユーザイベントを処理することをログに出力
//--- メッセージをラベルで表示する
ObjectSetString(0,labelID,OBJPROP_TEXT,sparam); // ラベルのテキストを更新
ChartRedraw(); // チャートオブジェクトの強制再描画
}
}
}
//+------------------------------------------------------------------+
//| 全ての開いているチャートにブロードキャストイベントを送信する関数 |
//+------------------------------------------------------------------+
void BroadcastEvent(long lparam,double dparam,string sparam)
{
int eventID=broadcastEventID-CHARTEVENT_CUSTOM; // イベントIDを設定
long currChart=ChartFirst(); // 最初のチャートを取得
int i=0; // カウンタを初期化
while(i<CHARTS_MAX) // 開いているチャートは確実に CHARTS_MAX 以内
{
EventChartCustom(currChart,eventID,lparam,dparam,sparam); // カスタムイベントを送信
currChart=ChartNext(currChart); // 次のチャートを取得
if(currChart==-1) break; // チャートリストの最後に達した場合ループを終了
i++; // カウンタを増加
}
}
サンプルコードに使われた関数や文法要素の簡単な解説
若干複雑なので小分けにして1つ1つ見ていきます。
変数定義部分
エキスパートアドバイザー(EA)の初期化に先立って、いくつかの重要な変数を定義します。これらの変数は、後でオブジェクトやイベントを識別するために使用されます。
string buttonID = "Button"; // ボタンオブジェクトの識別子
string labelID = "Info"; // ラベルオブジェクトの識別子
int broadcastEventID = 5000; // ブロードキャストイベントの識別子
ボタンオブジェクトの識別子
buttonID
変数は、ボタンオブジェクトを識別するために使用されます。ここでは、”Button”という文字列をボタンの名前として使用しています。ボタンを操作したりプロパティを設定したりする際に、この識別子を使ってボタンオブジェクトを特定します。
ラベルオブジェクトの識別子
labelID
変数は、ラベルオブジェクトを識別するために使用されます。ここでは、”Info”という文字列をラベルの名前として使用しています。ラベルを操作したりプロパティを設定したりする際に、この識別子を使ってラベルオブジェクトを特定します。
ブロードキャストイベントの識別子
broadcastEventID
変数は、ブロードキャストイベントを識別するために使用されます。この識別子を使って、他のチャートに送信するカスタムイベントを特定します。ここでは、5000という整数値をイベントIDとして使用しています。
これらの変数定義は、後でオブジェクトの作成やイベントの送信に必要な識別情報を提供するために重要です。
OnInit関数部分1
エキスパート初期化に使用される関数
OnInit関数は、エキスパートアドバイザー(EA)が初期化される際に自動的に呼び出されます。ここでは、カスタムイベントを送信するためのボタンオブジェクトを作成し、そのプロパティを設定します。
int OnInit()
{
//--- カスタムイベントを送信するボタンを作成する
ObjectCreate(0, buttonID, OBJ_BUTTON, 0, 0, 0); // ボタンオブジェクトの作成
ObjectSetInteger(0, buttonID, OBJPROP_COLOR, clrWhite); // ボタンの文字色を設定
ObjectSetInteger(0, buttonID, OBJPROP_BGCOLOR, clrGray); // ボタンの背景色を設定
ObjectSetInteger(0, buttonID, OBJPROP_XDISTANCE, 100); // ボタンのX座標を設定
ObjectSetInteger(0, buttonID, OBJPROP_YDISTANCE, 100); // ボタンのY座標を設定
ObjectSetInteger(0, buttonID, OBJPROP_XSIZE, 200); // ボタンの幅を設定
ObjectSetInteger(0, buttonID, OBJPROP_YSIZE, 50); // ボタンの高さを設定
ObjectSetString(0, buttonID, OBJPROP_FONT, "Arial"); // ボタンのフォントを設定
ObjectSetString(0, buttonID, OBJPROP_TEXT, "Button"); // ボタンのテキストを設定
ObjectSetInteger(0, buttonID, OBJPROP_FONTSIZE, 10); // ボタンのフォントサイズを設定
ObjectSetInteger(0, buttonID, OBJPROP_SELECTABLE, 0); // ボタンが選択可能かどうかを設定
ボタンオブジェクトの作成
ObjectCreate関数は新しいオブジェクトを作成します。最初の引数はチャートの識別子で、ここでは現在アクティブなチャートを指定するために0を使用しています。
次の引数はオブジェクトの名前で、buttonIDという変数に格納された名前を使用しています。この名前はボタンオブジェクトを識別するために使います。
次に、オブジェクトの種類を指定します。ここではOBJ_BUTTONを指定してボタンオブジェクトを作成します。
次の引数はサブウィンドウの番号を指定し、0はメインチャートウィンドウを意味します。
最後の二つの引数はオブジェクトの時間座標と価格座標を指定しますが、ボタンオブジェクトではこれらの値は無視されます。
ボタンのプロパティ設定
ObjectSetInteger関数とObjectSetString関数を使って、ボタンのプロパティを設定します。
まず文字色を設定します。clrWhiteは白色を示します。
次に背景色を設定します。clrGrayは灰色を示します。
ボタンの位置を設定します。X座標とY座標を設定し、チャートの左上隅からそれぞれ100ピクセルずつ離れた位置にボタンを配置します。
次にボタンのサイズを設定します。幅はピクセルピクセル、高さは50ピクセルです。
次にフォントを設定します。ここではArialを使用します。
ボタンに表示するテキストを設定します。ここではButtonというテキストが表示されます。
フォントサイズを設定します。ここではフォントサイズを10に設定します。
最後にボタンが選択可能かどうかを設定します。ここでは選択不可能(0)に設定します。
この部分のコードは、カスタムイベントを送信するためのボタンを作成し、その外観や動作を設定する役割を担っています。
OnInit関数部分2
情報を表示するラベルの作成と設定
//--- 情報を表示するラベルを作成する
ObjectCreate(0, labelID, OBJ_LABEL, 0, 100, 100); // ラベルオブジェクトの作成
ObjectSetInteger(0, labelID, OBJPROP_COLOR, clrRed); // ラベルの文字色を設定
ObjectSetInteger(0, labelID, OBJPROP_XDISTANCE, 100); // ラベルのX座標を設定
ObjectSetInteger(0, labelID, OBJPROP_YDISTANCE, 50); // ラベルのY座標を設定
ObjectSetString(0, labelID, OBJPROP_FONT, "Trebuchet MS"); // ラベルのフォントを設定
ObjectSetString(0, labelID, OBJPROP_TEXT, "No information"); // ラベルのテキストを設定
ObjectSetInteger(0, labelID, OBJPROP_FONTSIZE, 20); // ラベルのフォントサイズを設定
ObjectSetInteger(0, labelID, OBJPROP_SELECTABLE, 0); // ラベルが選択可能かどうかを設定
return(INIT_SUCCEEDED); // 初期化成功を返す
}
ラベルオブジェクトの作成
ObjectCreate関数を使って、情報を表示するためのラベルオブジェクトを作成します。
最初の引数はチャートの識別子で、0を指定することで現在アクティブなチャートにラベルが作成されます。次の引数はオブジェクトの名前で、labelID変数に格納された名前を使用します。
この名前を使ってラベルオブジェクトを識別します。オブジェクトの種類として、OBJ_LABELを指定してラベルオブジェクトを作成します。
サブウィンドウの番号には0を指定し、メインチャートウィンドウにラベルを配置します。最後の二つの引数は、時間座標と価格座標を指定しますが、ラベルオブジェクトでは無視されます。
ラベルのプロパティ設定
ObjectSetInteger関数とObjectSetString関数を使用して、ラベルのプロパティを設定します。
最初に文字色を設定します。clrRedは赤色を示します。
次に、ラベルの位置を設定します。X座標とY座標を設定し、チャートの左上隅からそれぞれ100ピクセルと50ピクセル離れた位置にラベルを配置します。
次に、ラベルのフォントを設定します。ここではTrebuchet MSというフォントを使用します。
ラベルに表示するテキストを設定します。ここでは”No information”というテキストが表示されます。
フォントサイズを設定します。ここではフォントサイズを20に設定します。
最後に、ラベルが選択可能かどうかを設定します。ここでは選択不可能(0)に設定します。
この部分のコードは、情報を表示するためのラベルを作成し、その外観や動作を設定する役割を担っています。これにより、チャート上にユーザーに対して情報を表示するラベルを配置することができます。
OnDeinit関数部分
エキスパート初期化解除に使用される関数
OnDeinit関数は、エキスパートアドバイザー(EA)が終了される際に自動的に呼び出されます。この関数は、終了時に必要なクリーンアップ処理を行うために使用されます。ここでは、初期化時に作成したボタンとラベルオブジェクトを削除します。
//+------------------------------------------------------------------+
//| エキスパート初期化解除に使用される関数 |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- ボタンとラベルを削除する
ObjectDelete(0, buttonID); // ボタンオブジェクトの削除
ObjectDelete(0, labelID); // ラベルオブジェクトの削除
}
ボタンとラベルを削除する
エキスパートアドバイザー(EA)が終了するときに呼び出されるOnDeinit関数では、チャート上に作成されたオブジェクトを削除する処理が行われます。
ObjectDelete関数を使用して、特定のオブジェクトをチャートから削除します。
最初の引数はチャートの識別子で、0を指定することで現在アクティブなチャートを対象にします。次の引数は削除するオブジェクトの名前で、buttonID
変数に格納された名前を使用します。これにより、初期化時に作成したボタンオブジェクトが削除されます。
次に、ObjectDelete関数を使用してラベルオブジェクトを削除します。手順はボタンオブジェクトの削除と同様で、ラベルオブジェクトの名前であるlabelID
変数を使用します。これにより、初期化時に作成したラベルオブジェクトが削除されます。
OnChartEvent関数部分1
チャートイベントを処理する関数
OnChartEvent関数は、チャート上で発生する様々なイベントを処理するために使用されます。この関数は、ユーザーがマウスボタンをクリックしたり、キーボードを操作したりしたときなど、様々なイベントが発生したときに自動的に呼び出されます。ここでは、ボタンがクリックされたイベントを処理し、その状態に応じてカスタムイベントを送信します。
void OnChartEvent(const int id, const long &lparam, const double &dparam, const string &sparam)
{
//--- マウスボタンを押してイベントをチェックする
if(id == CHARTEVENT_OBJECT_CLICK)
{
string clickedChartObject = sparam; // クリックされたオブジェクトの名前を取得
//--- buttonID の名称のオブジェクトをクリックした場合
if(clickedChartObject == buttonID)
{
//--- ボタンの状態—押されたか放された
bool selected = ObjectGetInteger(0, buttonID, OBJPROP_STATE); // ボタンの状態を取得
//--- デバッグメッセージをログする
Print("Button pressed = ", selected); // ボタンが押されたかどうかをログに出力
int customEventID; // 送信するカスタムイベントのID
string message; // イベントで送られるメッセージ
//--- ボタンが押された場合
if(selected)
{
message = "Button pressed"; // メッセージを設定
customEventID = CHARTEVENT_CUSTOM + 1; // カスタムイベントIDを設定
}
else // ボタンが押されていない場合
{
message = "Button is not pressed"; // メッセージを設定
customEventID = CHARTEVENT_CUSTOM + 999; // カスタムイベントIDを設定
}
//--- カスタムイベントを「自分の」チャートに送る
EventChartCustom(0, customEventID - CHARTEVENT_CUSTOM, 0, 0, message); // カスタムイベントを送信
//--- メッセージを全てのチャートに送る
BroadcastEvent(ChartID(), 0, "Broadcast Message"); // 全てのチャートにイベントを送信
//--- デバッグメッセージ
Print("Sent an event with ID = ", customEventID); // 送信したイベントIDをログに出力
}
ChartRedraw(); // チャートオブジェクトの強制再描画
}
}
マウスボタンを押してイベントをチェックする
id
がCHARTEVENT_OBJECT_CLICKである場合、このイベントが発生したことを示しています。CHARTEVENT_OBJECT_CLICKは、チャート上のオブジェクトがクリックされたときに発生するイベントです。
まず、クリックされたオブジェクトの名前をsparam
から取得します。この名前がbuttonID
と一致するかどうかを確認します。
ボタンがクリックされた場合の処理
クリックされたオブジェクトがbuttonID
と一致する場合、つまり、ボタンがクリックされた場合の処理を行います。ボタンの状態をObjectGetInteger関数を使って取得し、OBJPROP_STATEプロパティを調べます。OBJPROP_STATEプロパティは、ボタンが押されたかどうかを示します。
デバッグメッセージのログ出力
ボタンが押されたかどうかの状態をログに出力します。これにより、デバッグ時にボタンの状態を確認できます。
カスタムイベントのIDとメッセージの設定
ボタンが押された場合と押されていない場合で、異なるメッセージとカスタムイベントIDを設定します。ボタンが押された場合には「Button pressed」というメッセージを設定し、カスタムイベントIDをCHARTEVENT_CUSTOM + 1
に設定します。ボタンが押されていない場合には「Button is not pressed」というメッセージを設定し、カスタムイベントIDをCHARTEVENT_CUSTOM + 999
に設定します。
カスタムイベントIDに+1
や+999
を足しているのは、それぞれ異なるイベントを区別するためです。CHARTEVENT_CUSTOMはカスタムイベントの基準値として使用され、その値に特定の数値を足すことで、イベントの種類を識別します。例えば、+1
はボタンが押された状態を示し、+999
はボタンが押されていない状態を示します。この方法により、異なるカスタムイベントを一意(1つしか存在しない)に識別することができます。
カスタムイベントを送信
EventChartCustom関数を使って、設定したメッセージとカスタムイベントIDを持つカスタムイベントを送信します。送信先は0
を指定することで現在のチャートになります。
全てのチャートにメッセージを送信
BroadcastEvent関数を呼び出して、全てのチャートに「Broadcast Message」というメッセージを送信します。
※BroadcastEvent関数はオリジナルの関数で、この後定義しています。
デバッグメッセージのログ出力
送信したカスタムイベントIDをログに出力します。これにより、デバッグ時に送信されたイベントIDを確認できます。
チャートオブジェクトの強制再描画
最後に、ChartRedraw関数を呼び出してチャートオブジェクトを強制的に再描画します。これにより、チャート上のオブジェクトの状態が正しく反映されます。
OnChartEvent関数部分2
ユーザイベントの処理
//--- イベントがユーザイベントかどうかチェックする
if(id > CHARTEVENT_CUSTOM)
{
if(id == broadcastEventID)
{
Print("Got broadcast message from a chart with id = " + lparam); // ブロードキャストメッセージを受信したことをログに出力
}
else
{
//--- イベントのテキストメッセージを読む
string info = sparam; // イベントのメッセージを取得
Print("Handle the user event with the ID = ", id); // ユーザイベントを処理することをログに出力
//--- メッセージをラベルで表示する
ObjectSetString(0, labelID, OBJPROP_TEXT, sparam); // ラベルのテキストを更新
ChartRedraw(); // チャートオブジェクトの強制再描画
}
}
ユーザイベントかどうかをチェックする
id
がCHARTEVENT_CUSTOMより大きい場合、このイベントがユーザイベントであることを示します。ユーザイベントは、ユーザが定義したカスタムイベントであり、標準のシステムイベントとは異なります。
ブロードキャストメッセージの処理
id
がbroadcastEventID
と等しい場合、これはブロードキャストメッセージが受信されたことを示します。Print関数を使用して、ブロードキャストメッセージを受信したことをログに出力します。このとき、lparam
には送信元チャートのIDが含まれています。
その他のユーザイベントの処理
id
がbroadcastEventID
ではない場合、これはその他のユーザイベントを処理する部分です。まず、イベントのテキストメッセージをsparam
から取得します。このメッセージは、イベントに関連する追加情報を含む文字列です。
Print関数を使用して、ユーザイベントを処理することをログに出力します。これにより、デバッグ時にイベントが正しく処理されているかを確認できます。
メッセージをラベルで表示する
次に、ObjectSetString関数を使用して、ラベルオブジェクトのテキストを更新します。ラベルの名前はlabelID
で指定され、テキストはsparam
の内容に設定されます。これにより、受信したイベントメッセージがラベルに表示されます。
チャートオブジェクトの強制再描画
最後に、ChartRedraw関数を呼び出してチャートオブジェクトを強制的に再描画します。これにより、ラベルのテキストが正しく表示され、チャート上のオブジェクトの状態が更新されます。
この部分のコードは、ユーザが定義したカスタムイベントを処理し、その内容をラベルに表示する役割を担っています。また、ブロードキャストメッセージの受信をログに出力することで、他のチャートからのメッセージも処理します。
BroadcastEvent関数の定義部分
全ての開いているチャートにブロードキャストイベントを送信する関数
BroadcastEvent
関数は、全ての開いているチャートに対してカスタムイベントを送信するために使用されます。この関数は、特定のイベントIDとメッセージをすべてのチャートに送信し、複数のチャート間で情報を共有する際に役立ちます。
//+------------------------------------------------------------------+
//| 全ての開いているチャートにブロードキャストイベントを送信する関数 |
//+------------------------------------------------------------------+
void BroadcastEvent(long lparam, double dparam, string sparam)
{
int eventID = broadcastEventID - CHARTEVENT_CUSTOM; // イベントIDを設定
long currChart = ChartFirst(); // 最初のチャートを取得
int i = 0; // カウンタを初期化
while (i < CHARTS_MAX) // 開いているチャートは確実に CHARTS_MAX 以内
{
EventChartCustom(currChart, eventID, lparam, dparam, sparam); // カスタムイベントを送信
currChart = ChartNext(currChart); // 次のチャートを取得
if (currChart == -1) break; // チャートリストの最後に達した場合ループを終了
i++; // カウンタを増加
}
}
イベントIDの設定
まず、broadcastEventID
からCHARTEVENT_CUSTOMを引いた値をeventID
として設定します。このイベントIDは、他のイベントと区別するための一意な識別子として使用されます。
最初のチャートを取得
ChartFirst関数を使用して、最初のチャートの識別子を取得します。ChartFirst関数は、開いている最初のチャートのIDを返します。この識別子を使って、最初のチャートに対してカスタムイベントを送信します。
カウンタの初期化
i
というカウンタを初期化します。このカウンタは、開いているチャートの数を追跡するために使用されます。
whileループの開始
while文を使用してループを開始します。このループは、開いているすべてのチャートに対してカスタムイベントを送信するために使用されます。ループの条件はi < CHARTS_MAX
です。CHARTS_MAX
は、同時に開くことができる最大のチャート数を示します。
カスタムイベントの送信
EventChartCustom関数を使用して、現在のチャートにカスタムイベントを送信します。currChart
は現在のチャートの識別子で、eventID
は先ほど設定したイベントIDです。lparam
、dparam
、sparam
は、イベントに関連する追加情報を渡します。
次のチャートを取得
ChartNext関数を使用して、次のチャートの識別子を取得します。ChartNext関数は、現在のチャートの次に開いているチャートのIDを返します。
ループの終了条件
if (currChart == -1) break;
という条件で、チャートリストの最後に達した場合にループを終了します。ChartNext関数が-1
を返した場合、それはリストの最後に達したことを意味します。
カウンタの増加
最後に、i++
でカウンタを増加させます(インクリメント)。この操作は、ループが正しく終了するために必要です。
このBroadcastEvent
関数は、開いているすべてのチャートにカスタムイベントを送信するための重要な役割を果たします。