ChartSetString 関数
この関数は、指定したチャートに対応するプロパティ値を設定します。設定するプロパティ値は文字列型 (string型) です。
コマンドはチャートメッセージキューに追加され、前のすべてのコマンドが処理された後に実行されます。
データ型と構成・戻り値
bool ChartSetString(①, ②, ③);戻り値は、処理が成功した場合は true、それ以外は falseが返されます。
発生するエラーについては、GetLastError関数で取得することができます。
引数 [3]
ChartSetString関数は 3個の引数で構成されます。
| 番 号 | 引数名 | データ型 | 単位 | 初期値 | 説明 |
|---|---|---|---|---|---|
| ① | chart_id | long | － | － | 対象とするチャートID。 0は現在のチャートを表します。 |
| ② | prop_id | int | － | － | チャートプロパティIDの識別子。ENUM_CHART_PROPERTY_STRING から選択します。 |
| ③ | str_value | string | － | － | 文字列のプロパティ値。2045文字まで。超過分は切り捨てられます。 |
使用例
ChartSetString関数によるチャートへのコメント出力
ChartSetString関数を使って現在のチャートにコメントを出力します。
これはComment関数と同様の処理になります。
コード
// ChartSetString関数によるチャートへのコメント出力
#property strict
void OnInit() {
ChartSetString(0, CHART_COMMENT, "ChartSetString関数で出力したコメント"); // 20
}
コードをコンパイルして実行する方法はこちらを参考にしてください。(デモ口座でお試しください)
行の後ろにあるコメントの数値は、引数②の識別子に対応する値です。識別子の代わりにこの値を使うこともできます。
結果
チャートの状態であるプロパティ値を取得する場合はChartGetString関数を使います。