この記事を開いてくださったこと、心から感謝しています。チャート上のラベルや線の文字を、プログラムから読んだり書き換えたりしたい人も、きっと多いはずです。
結論から言うと、オブジェクトの文字情報を読み取るならObjectGetString、文字や説明を書き換えるならObjectSetStringです。読む関数と、書く関数という違いがあり、動き方にも差があります。
また、文字数の上限など、確認した公式ページに書かれていない点もありました。その部分は、そのつど「記載なし」と書いています。
この記事では、MQL5公式リファレンスの説明をもとに、2つの関数の役割・引数・戻り値・公式サンプル・使い分けを整理します。なお、ここで扱うのはプログラムの仕組みの説明で、運用の助言ではありません。
ObjectGetStringとObjectSetStringは、そもそも何が違うのか?
まずは、公式リファレンスに書かれている、2つの関数の基本の違いを整理します。1つは文字列のプロパティを読み取る関数で、もう1つは書き込む関数です。
ObjectGetStringは、文字列のプロパティを読み取る
ObjectGetStringは、チャート上のオブジェクトから、文字列型のプロパティを取得する関数です。引数は、チャートID、オブジェクト名、プロパティの種類、修飾子の順です。
書き方は2通りあります。1つは文字列そのものを返す形で、もう1つは結果をboolで返し、取得した文字列を引数の変数へ入れる形です。
- チャート上のオブジェクトから、文字列を読み取る
- 文字列を直接返す形と、変数へ入れる形の2通りがある
- 変数へ入れる形は、成功ならtrue、失敗ならfalseを返す
ObjectSetStringは、文字列のプロパティを書き込む
ObjectSetStringは、オブジェクトの文字列型のプロパティに、値を設定する関数です。戻り値はbool型で、変更の命令をチャートへ送れたときだけ、trueになります。
こちらも、修飾子つきの書き方があります。修飾子は、フィボナッチ系のツールやアンドリューズ・ピッチフォークの、レベルの番号を表し、0から数えます。
- オブジェクトの文字列プロパティへ、値を設定する
- 戻り値は、命令を送れたときだけtrue
- 修飾子つきの書き方もある
2つを、表で比べる
公式の説明から読み取れる違いを、表にまとめます。選ぶときの目安として使ってください。
| 項目 | ObjectGetString | ObjectSetString |
|---|---|---|
| 役割 | 文字列プロパティを読み取る | 文字列プロパティを書き込む |
| 書き方 | 2通り(直接返す・変数へ入れる) | 2通り(修飾子なし・あり) |
| 戻り値 | 文字列、またはbool | bool |
| 同期か非同期か | 同期 | 非同期 |
| エラーの調べ方 | falseのときGetLastError | falseのときGetLastError |
※公式の説明をもとにした、筆者の整理です。
ObjectGetStringは、どんな場面で使うのか?
ObjectGetStringは、すでにあるオブジェクトの文字情報を、確かめたいときの関数です。公式の説明から、使い方と注意点を確認します。
プロパティは、文字列型のものだけを指定する
プロパティの種類には、ENUM_OBJECT_PROPERTY_STRINGの値を渡します。公式の説明では、指定するプロパティは、文字列型でなければならないと書かれています。
整数や実数のプロパティを読み取るときは、別の関数を使います。それらは、ObjectGetIntegerとObjectGetDoubleの記事で整理しています。
- 文字列型のプロパティだけを指定できる
- 整数や実数は、別の関数で読み取る
- チャートIDの0は、現在のチャートを意味する
2通りの書き方は、戻り値の形が違う
1つ目の書き方は、文字列をそのまま返すので、受け取って使うだけの手軽さがあります。2つ目は、boolで成否を返し、文字列は引数の変数へ入ります。
失敗したときの動きは、2つ目の書き方だけ明記されています。1つ目の書き方が失敗したときに、何を返すのかは、確認したページには記載なしでした。
| 書き方 | 戻り値 | 失敗の知らせ方 |
|---|---|---|
| 直接返す形 | 文字列 | 記載なし |
| 変数へ入れる形 | bool | falseを返す |
※公式の説明をもとにした、筆者の整理です。
同期で動くので、重くなることがある
公式の説明では、ObjectGetStringは同期の呼び出しです。そのチャートへ、先に送られている命令がすべて終わるのを待ってから、値を返します。
そのため、オブジェクトが多いチャートでは、動作が遅くなる可能性がある、と書かれています。読み取る回数は、必要な分に絞るのが安心です。
- 先に送られた命令の完了を、待ってから返す
- オブジェクトが多いと、遅くなることがある
- 読み取る回数は、必要な分に絞る
ObjectSetStringは、どんな場面で使うのか?
ObjectSetStringは、ラベルの文字や、ツールチップなどを書き換えたいときに使います。公式の説明から、動き方の特徴を確認します。
非同期なので、trueでも反映の確認にはならない
公式の説明では、ObjectSetStringは非同期です。実行の完了を待たず、命令をキューへ入れるだけなので、trueが返っても、変更が反映された証拠にはなりません。
反映を確かめたいときは、ObjectGetStringのような、読み取りの関数を使います。ただし、読み取りは、キューの最後に並ぶので、時間がかかることがある、と書かれています。
- 命令をキューへ入れるだけで、完了は待たない
- trueは、命令を送れたことだけを意味する
- 反映の確認には、読み取りの関数を使う
変更の見た目は、描き直して反映する
プロパティを変えても、画面にはすぐ現れないことがあります。公式の例では、変更はキューに入り、処理されるまで見えないため、ChartRedrawで更新すると説明されています。
ChartRedrawは、チャートを強制的に描き直す関数です。文字を書き換えたあとに、描き直す、という組み合わせになります。
- 変更はキューに入り、処理されるまで見えない
- 画面へ反映するには、ChartRedrawを呼ぶ
- 公式の例は、最後に1回だけ呼んでいる
文字列型のプロパティは、いくつもある
公式の一覧には、文字列型のプロパティが、いくつか載っています。代表的なものを、表にして確認しましょう。
| プロパティ | 公式の説明 |
|---|---|
| OBJPROP_TEXT | オブジェクトの説明(含まれる文字) |
| OBJPROP_NAME | オブジェクトの名前 |
| OBJPROP_TOOLTIP | ツールチップの文字 |
| OBJPROP_FONT | フォント |
| OBJPROP_BMPFILE | ビットマップラベルのBMPファイル名 |
※公式の説明をもとにした、筆者の整理です。ほかに、レベルの説明や銘柄を表すものもあります。
公式のサンプルは、どう書かれているのか?
公式ページには、書き込みと読み取りを、組み合わせたサンプルがあります。動きの流れが分かりやすい、短いスクリプトです。
水平線に、Bid価格の説明を付けて読み取る
ObjectSetStringのサンプルは、まず、オブジェクトの説明を表示する設定をオンにします。次に、Bidを取得して、その位置へ水平線を作ります。
そのあと、OBJPROP_TEXTへ、Bidの値を含む文字を書き込みます。ChartRedrawで描き直してから、書き込んだ文字と名前を、ObjectGetStringで読み取って表示します。
最後に、2秒待ってオブジェクトを削除し、表示の設定を元へ戻します。出力例は、名前と説明を並べた1行の文で、数値は公式ページの例のものです。
- 説明の表示をオンにして、水平線を作る
- OBJPROP_TEXTへ、Bidの値を含む文字を書く
- ObjectGetStringで読み取り、表示する
ラベルに、記号の文字とフォントを設定する
プロパティの一覧のページには、別の例があります。ラベルを作り、文字にWingdingsの記号を設定し、フォントもWingdingsにして、角度を45度にします。
設定のあとに、ChartRedrawを呼んで、画面を更新しています。文字とフォントをセットで変える、という使い方の例です。ラベルの種類の違いは、OBJ_LABELとOBJ_TEXTの記事が参考になります。
| 例 | 設定する内容 |
|---|---|
| Bidの水平線 | OBJPROP_TEXTへ、価格を含む文字 |
| ラベル | OBJPROP_TEXTとOBJPROP_FONT |
※公式サンプルの内容を、筆者が整理しました。
サンプルの細かい注意点
ObjectSetStringのサンプルには、読み取りに失敗したときのメッセージが、別の関数名で書かれている箇所があります。写して使うときは、メッセージの内容を、自分で確認すると安心です。
- サンプルのメッセージは、そのまま写さない
- 読み取りの関数名は、自分で確かめる
- 動かす前に、小さな範囲で試す
どう使い分ければよいのか?
2つは競合する関数ではなく、役割が違います。読みたいのか、書きたいのかで、使い分けます。
読み取りたいなら、ObjectGetStringを選ぶ
すでに設定されている文字を、確認したいときは、ObjectGetStringが向いています。書き込みの結果を確かめるときにも、使えます。
FX口座・ツールの比較一覧もあわせて確認してみてください。
書き換えたいなら、ObjectSetStringを選ぶ
ラベルの文字や、ツールチップなどを変えたいときは、ObjectSetStringが向いています。命令を送るだけなので、呼び出しは軽く済みます。
- 文字や説明を、書き換えたい
- 非同期で、完了は待たなくてよい
- 反映は、ChartRedrawで更新する
組み合わせるなら、書いてから読んで確かめる
公式のサンプルは、書き込んでから描き直し、読み取って表示する流れでした。この順番は、変更が通ったかを確かめたいときの、1つの形です。









もう1つのコツは、戻り値がfalseのときの処理を、先に決めておくことです。GetLastErrorで調べる形にしておくと、原因を追いやすくなります。
- falseのときの処理を、先に決めておく
- 結果は、まずログに出して確かめる
- 文字数の上限は記載なしなので、短い文字で試す
よくある質問にはどんなものがあるのか?
始める前に、多くの人が気になる疑問を短くまとめます。
ObjectSetStringがtrueなら、画面は変わっているのか?
いいえ、trueは、命令を送れたことを意味するだけです。公式の説明では、非同期のため、変更が反映された証拠にはなりません。
- trueは、命令を送れたことだけを意味する
- 反映の確認は、読み取りの関数で行う
文字数の上限は、いくつなのか?
確認したページには、文字数の上限は記載なしでした。長い文字を扱うときは、自分の環境で動きを確かめてから使うのが安全です。
- 文字数の上限は、記載なし
- 長い文字は、先に小さく試す
この記事の例は、実際の結果なのか?
いいえ、公式サンプルの内容と、筆者が整理した説明です。実際の動きや、将来の結果を示すものではありません。
- 公式サンプルの内容をもとにした説明
- 実際の動きとは異なる場合がある
まとめ:「MQL5のObjectGetStringとObjectSetString、オブジェクトの文字情報を読み取れる確かさと文字や説明を書き換えられる手軽さどっちを選ぶ?」
文字情報を読み取るならObjectGetString、文字や説明を書き換えるならObjectSetStringです。同期と非同期の違いを知り、記載のない点は自分の環境で確かめてから使いましょう。
仕組みが分かると、コードを書くのが少しずつ楽しくなっていきます。この記事が、あなたの毎日に少しでも余裕と安心を運ぶきっかけになれば、心から嬉しく思います。
出典・参照元
※本ページに掲載している口コミ・体験談は、特定の個人を特定できないよう配慮しており、ウェブサイトおよびSNS上の公開情報をもとに編集しています。個人の体験に基づく情報であり、すべての方に同じ効果や変化が生じることを保証するものではありません。料金・サービス内容は変更される場合があるため、最新情報は必ず公式サイトでご確認ください。










