ChartGetString

指定されたチャートの対応するプロパティの値を返します。チャートプロパティは string 型でなければなりません。この関数の呼び出し方は 2 つあります。

1. 直接プロパティ値を返します。

string  ChartGetString(
  long  chart_id,          // チャート識別子
  int  prop_id           // プロパティ識別子
  );

2. 関数の成功に応じて、true または false を返します。成功した場合、プロパティの値は、参照によって渡された目的変数string_varに配置されます。

bool  ChartGetString(
  long    chart_id,        // チャート識別子
  int    prop_id,        // プロパティ識別子
  string& string_var     // プロパティのターゲット変数 property
  );

パラメータ

chart_id

[in]  チャート識別子。( 0 は現在のチャート)

prop_id

[in]  チャートプロパティ識別子。値は ENUM_CHART_PROPERTY_STRING のいずれかです。

string_var

[out]  要求されたプロパティの string 型のターゲット変数

戻り値

string 型の値

2 番目の呼び方では、指定されたプロパティが利用可能であり、その値が string_var 変数に置かれている場合には、trueを返します。そうでない場合は falseを返します。エラーについての追加情報を取得するには、GetLastError()関数を呼び出します。

注意事項

ChartGetString は Comment または ChartSetString 関数を使用してチャートにプロットされたコメントを読むために使用されます。

この関数は同期型です。つまり、呼び出し前にチャートキューに追加されたすべてのコマンドの実行を待機します。

例:

void OnStart()
 {
  ChartSetString(0,CHART_COMMENT,"Test comment.\nSecond line.\nThird!");
  ChartRedraw();
  Sleep(1000);
  string comm=ChartGetString(0,CHART_COMMENT);
  Print(comm);
 }

参照

コメントChartSetString