GlobalVariablesDeleteAll 関数
この関数は、指定したクライアントターミナルのグローバル変数を一括削除して、削除したグローバル変数の数を取得します。
(プログラム内で宣言するグローバル変数との違いはこちらを参考にしてください)
クライアントターミナルのグローバル変数は、最後に使用してから 4週間クライアントクライアントターミナルで保存され、その後自動的に削除されるのでご注意ください。
データ型と構成・戻り値
int GlobalVariablesDeleteAll(①, ②);戻り値は、削除したグローバル変数の数が返されます。
発生するエラーについては、GetLastError関数で取得することができます。
引数 [2]
GlobalVariablesDeleteAll関数は 1個の引数で構成されます。
| 番 号 | 引数名 | データ型 | 単位 | 初期値 | 説明 |
|---|---|---|---|---|---|
| ① | prefix_name | string | － | NULL | 削除するクライアントターミナルのグローバル変数名の接頭辞。 「NULL」は全ての変数名が削除対象になります。 |
| ② | limit_data | datetime | － | 0 | 削除対象にするグローバル変数の最終アクセス時刻。この最終アクセス時刻より前にアクセスしたグローバル変数が削除対象になります。 「0」は全ての最終アクセス時刻が削除対象です。 最終アクセス時刻はローカル時間です。 |
最終アクセス時刻は、GlobalVariableGet関数や GlobalVariableCheck関数でも更新されます。
使用例
GlobalVariablesDeleteAll関数によるグローバル変数の削除
GlobalVariablesDeleteAll関数を使って現在クライアントターミナルに保存されているグローバル変数を削除します。削除するグローバル変数名は接頭辞に「gvar」がある変数名とします。
クライアントターミナルのグローバル変数は、
① 変数名「gvar1」、値「123.456」
② 変数名「gvar2」、値「789」
③ 変数名「test1」、値「456.789」
とします。設定方法は、こちらを参考にしてください。(クライアントターミナルのグローバル変数は、GlobalVariableSet関数からでも設定ができます)
コード
// GlobalVariablesDeleteAll関数によるグローバル変数の削除
#property strict
void OnInit() {
int n = GlobalVariablesDeleteAll("gvar");
Print("削除したグローバル変数の数：", n);
}コードをコンパイルして実行する方法はこちらを参考にしてください。(デモ口座でお試しください)
結果
クライアントターミナルからグローバル変数を確認すると、先頭に「gvar」が付いているグローバル変数が削除されていることを確認できます。
