メインコンテンツまでスキップ

closeBackgroundForm

Description

バックグラウンドフォームを終了し、メモリから完全に解放します。openBackgroundForm()に登録したコールバックにresult値を渡します。

Parameters

パラメーター説明
formPathString閉じるフォームのパス
resultdynamicフォームのopenerのコールバックに渡す結果値

Returns

void

Notes

  • フォームインスタンスがメモリから削除されます。その後、同じパスでopenBackgroundForm()を呼び出すと新しく読み込まれます。
  • 読み込まれていないパスを指定してもエラーは発生しません(無視されます)。
  • 通常はバックグラウンドフォーム内部のスクリプトから呼び出します。外部から強制終了することもできます。

Example

// 外部からフォームを強制終了
$app.closeBackgroundForm("alarm/watcher", { cancelled: true });

// バックグラウンドフォーム内部で結果を返してから終了
// (フォーム内部のスクリプトから)
$app.closeBackgroundForm("alarm/watcher", { ok: true, data: someData });
  • $app.openBackgroundForm(formPath, linkArg, callback) — バックグラウンドフォームを開く
  • $app.hideBackgroundForm(formPath) — 終了せずUIのみ非表示にする
  • $app.isBackgroundFormLoaded(formPath) — 読み込み状態を確認する