GlobalVariableDel 関数
この関数は、指定したクライアントターミナルのグローバル変数を削除します。
(プログラム内で宣言するグローバル変数との違いはこちらを参考にしてください)
クライアントターミナルのグローバル変数は、最後に使用してから 4週間クライアントクライアントターミナルで保存され、その後自動的に削除されるのでご注意ください。
データ型と構成・戻り値
bool GlobalVariableDel(①);
戻り値は、クライアントターミナルから指定したクライアントターミナルのグローバル変数の削除が成功した場合は true、それ以外は falseが返されます。
発生するエラーについては、GetLastError関数で取得することができます。
引数 [1]
GlobalVariableDel関数は 1個の引数で構成されます。
番 号 | 引数名 | データ型 | 単位 | 初期値 | 説明 |
---|---|---|---|---|---|
① | name | string | - | - | 削除するクライアントターミナルのグローバル変数名。 |
使用例
GlobalVariableDel関数によるグローバル変数の削除
GlobalVariableDel関数を使って現在保存されているグローバル変数を削除します。
クライアントターミナルのグローバル変数は、 変数名「gvar1」、値「123.456」と変数名「gvar2」、値「789」とします。設定方法は、こちらを参考にしてください。(クライアントターミナルのグローバル変数は、GlobalVariableSet関数からでも設定ができます)
コード
// GlobalVariableDel関数によるグローバル変数の削除
#property strict
void OnInit() {
bool tf = GlobalVariableDel("gvar1");
Print("グローバル変数の削除可否:", tf);
}
コードをコンパイルして実行する方法はこちらを参考にしてください。(デモ口座でお試しください)
結果
クライアントターミナルからグローバル変数「gva1」を確認すると削除されていることが確認できます。