ChartGetString 関数
この関数は、指定したチャートの指定したプロパティ値を取得します。取得するプロパティ値は、文字列型 (string型) です。関数の呼び出し方法には 2つの型があります。
データ型と構成・戻り値
この関数には 2つの型があります。
string ChartGetString(①, ②);
bool ChartGetString(①, ②, ③);string型の時、戻り値は、string型の値を返します。
bool型の時、戻り値は、指定したプロパティが使用可能で、その値が引数③に格納される場合は true、それ以外は falseを返します。
発生するエラーについては、GetLastError関数で取得することができます。
引数 [3]
ChartGetString関数は 2～3個の引数で構成されます。
| 番 号 | 引数名 | データ型 | 単位 | 初期値 | 説明 |
|---|---|---|---|---|---|
| ① | chart_id | long | － | － | チャートIDを指定します。現在のチャートIDは「0」を指定するか、ChartID関数を使うことで取得できます。 |
| ② | prop_id | int | － | － | チャートプロパティの識別子。ENUM_CHART_PROPERTY_STRING 列挙値から選択。 |
| ③ | string_var | double& | － | － | 取得したプロパティ値が設定される string型の変数。 |
使用例
ChartGetString関数によるコメント内容の取得
現在表示しているチャートの左上に表示されるコメント内容を ChartGetString関数を使って取得します。コメント内容については予め ChartSetString関数で作成しておきます。
コード
// ChartGetString関数によるコメント内容の取得
#property strict
void OnInit() {
ChartSetString(0, CHART_COMMENT, "ChartSetString関数で出力したコメント");
Print("コメント内容：", ChartGetString(0, CHART_COMMENT)); // 20
}コードをコンパイルして実行する方法はこちらを参考にしてください。(デモ口座でお試しください)
行の後ろにあるコメントの数値は、引数②の識別子に対応する値です。識別子の代わりにこの値を使うこともできます。
結果
チャートの状態であるプロパティ値を設定する場合は ChartSetString関数を使います。