mxsdoc

StartupLoader.ms

依存

global startupLoader

変数
<Struct:StartupLoaderStruct>

struct StartupLoaderStruct

スタートアップスクリプトを管理する。

private hasSystemShutdownStarted

プロパティ
<BooleanClass>

シャットダウンプロセスが開始されたかどうか。既定値はfalse

private installerFlags

プロパティ
<Array[<BooleanClass>]>

スクリプトファイルをインストーラとして評価するかどうか。既定値は#()

private scriptFiles

プロパティ
<Array[<String>]>

登録スクリプトファイル。既定値は#()

private startupFilePath

プロパティ
<String>

スタートアップファイルのパス。既定値は""

private dateTimeClass

プロパティ
<DotNetClass:System.DateTime>

private fileClass

プロパティ
<DotNetClass:System.IO.File>

private globalVarName

プロパティ
<String>

自己のインスタンスを格納するグローバル変数の名前。既定値は"startupLoader"

private pathClass

プロパティ
<DotNetClass:System.IO.Path>

private utf8withoutBOM

プロパティ
<DotNetObject:System.Text.UTF8Encoding>

public fn GetInstallerFlags

スクリプトファイルをインストーラとして評価するかどうかを取得する。

戻り値
<Array[<BooleanClass>]>

public fn GetScriptFiles

登録スクリプトファイルを取得する。

戻り値
<Array[<String>]>

public fn GetStartupFilePath

スタートアップファイルのパスを取得する。

戻り値
<Array[<String>]>

public fn Install

インストールする。

戻り値
<OkClass>
補足

静的メソッド。

public fn OnPreSystemShutdown

#PreSystemShutdownコールバックによって呼び出されるメソッド。

public fn RegisterFile

スクリプトファイルを登録する。

パラメータ
scriptFilePath
<String>
パラメータ
installer:
<BooleanClass>

ファイルをインストーラとして評価する場合はtrue、通常のスクリプトとして評価する場合はfalse。既定値はfalse

戻り値
<BooleanClass>

成功した場合(既に登録済みの場合も)はtrue、失敗した場合はfalse

補足

登録したスクリプトファイルをインストーラとして評価するには以下の条件を満たす必要がある。

  • スクリプトファイルの評価結果が構造体定義であること

  • 引数を持たない静的メソッドInstallを持っていること

public fn Uninstall

アンインストールする。

戻り値
<OkClass>

public fn UnregisterFile

スクリプトファイルを登録解除する。

パラメータ
scriptFilePath
<String>
戻り値
<BooleanClass>

成功した場合(元から登録されていない場合も)はtrue、失敗した場合はfalse

補足

ツールの終了処理によって状態が変更されることを防ぐため、シャットダウンプロセス中は処理を行わない。

public fn Write

内部状態をスタートアップファイルに書き出す。

戻り値
<OkClass>

private fn deleteStartupFile

スタートアップファイルを削除する。

戻り値
<BooleanClass>

成功した場合はtrue、失敗した場合はfalse

private fn existsStartupFile

スタートアップファイルが存在するかどうかを判定する。

戻り値
<BooleanClass>

private fn initializeStartupFilePath

スタートアップファイルのファイル名を初期化する。

戻り値
<OkClass>

private fn registerPreSystemShutdown

#PreSystemShutdownコールバックを登録する。

戻り値
<OkClass>

private fn unregisterPreSystemShutdown

#PreSystemShutdownコールバックを登録解除する。

戻り値
<OkClass>

private version

プロパティ
<Array[<Integer>]>

バージョン番号。メジャー、マイナー、パッチの順。

public fn StructName

戻り値
<Name>

public fn Dump

パラメータ
indent:
<String>
パラメータ
out:
<FileStream|StringStream|WindowStream>

出力先。既定値はlistener

戻り値
<OkClass>

public fn Equals

パラメータ
obj
<Any>
戻り値
<BooleanClass>
補足

大文字と小文字を区別する。

public fn GetVersion

戻り値
<Array[<Integer>]>