mxsdoc

Config.ms

依存

struct ConfigStruct

設定ファイルの管理を行う。

補足
作成パラメータ
ConfigStruct filePath

public _CP1_

プロパティ
<String|UndefinedClass>

作成パラメータ1。保存先ファイルのパス。既定値はundefined

private filePath

プロパティ
<String|UndefinedClass>

保存先ファイルのパス。既定値はundefined

private table

プロパティ
<Dictionary <Name> <Any>>

値の辞書。既定値はundefined

private dateTimeClass

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

private fileUtility

プロパティ
<Struct:FileUtilityStruct>

private pathUtility

プロパティ
<Struct:PathUtilityStruct>

private stringUtility

プロパティ
<Struct:StringUtilityStruct>

public fn AddValue

値を追加する。

パラメータ
key
<Name>
パラメータ
v
<Any>
戻り値
<BooleanClass>

キーが存在する場合はtrue、存在しない場合はfalse

public fn Clear

内容を全て消去する。

戻り値
<OkClass>

public fn Count

値の総数を取得する。

戻り値
<Integer>

public fn GetFilePath

保存先ファイルのパスを取得する。

戻り値
<String|UndefinedClass>

public fn GetKeys

全てのキーを取得する。

戻り値
<Array[<Name>]>
補足

キーの並びは通常のsort関数で昇順にソートされる。

public fn GetValue

値を取得する。

パラメータ
key
<Name>
パラメータ
default:
<Any>

キーが存在しない場合に返す値。既定値はundefined

戻り値
<Any>

public fn HasValue

キーが存在するかどうかを取得する。

パラメータ
key
<Name>
戻り値
<BooleanClass>

public fn Read

保存先ファイルの内容を読み込んで内部状態を更新する。

戻り値
<BooleanClass>

読み込みに成功した場合はtrue、失敗した場合はfalse

補足

保存先ファイルのパスが無効の場合は何もしない。

public fn SetFilePath

保存先ファイルのパスを設定する。

パラメータ
input
<String|UndefinedClass>

拡張子を含むファイルパス。

戻り値
<String|UndefinedClass>
補足

ファイルの拡張子は.mxsconfigに置き換えられる。

public fn Write

内容を保存先ファイルに書き出す。

戻り値
<BooleanClass>

書き出しに成功した場合はtrue、失敗した場合はfalse

補足

保存先ファイルのパスが無効の場合は何もしない。

private fn isValidFilePath

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

public fn StructName

戻り値
<Name>

public fn Dump

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

出力先。既定値はlistener

戻り値
<OkClass>

public fn Equals

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

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