mxsdoc

struct PathUtilityStruct

ファイルまたはディレクトリのパス情報を操作する。

補足

作成パラメータ

PathUtilityStruct [baseDirectory]

public _CP1_

プロパティ

<String>

作成パラメータ1。ベースディレクトリ。既定値はundefined。

補足

未指定の場合は本ファイルの配置されたディレクトリがベースディレクトリとなる。

private baseDirectory

プロパティ

<String>

private directoryClass

プロパティ

<DotNetClass:System.IO.Directory>

private environmentClass

プロパティ

<DotNetClass:System.Environment>

private pathClass

プロパティ

<DotNetClass:System.IO.Path>

public fn ChangeExtension

パスの拡張子を変更する。

パラメータ

path

<String>

パラメータ

extension

<String>

新しい拡張子（先行ピリオド付き、またはなし）。

戻り値

<String>

public fn GetBaseDirectory

ベースディレクトリを取得する。

戻り値

<String>

public fn GetDirectoryName

パスのディレクトリ情報を取得する。

パラメータ

path

<String>

戻り値

<String|UndefinedClass>

ルートディレクトリの場合はundefinedを返す。

補足

取得したディレクトリ情報がルートディレクトリの場合にのみパスの末尾に"\"が付く。

パス	結果
@"C:\Dir\File.ext"	"C:\Dir"
@"C:\Dir\"	"C:\Dir"
@"C:\Dir"	"C:\"
@"C:\"	undefined

public fn GetExtension

パスの拡張子（ピリオドを含む）を取得する。

パラメータ

path

<String>

戻り値

<String>

補足

パスが拡張子を持たない場合は""を返す。

public fn GetFileName

パスのファイル名と拡張子を取得する。

パラメータ

path

<String>

戻り値

<String>

補足

パスの最後の文字がディレクトリ区切り記号、またはボリューム区切り記号の場合は""を返す。

public fn GetFileNameWithoutExtension

パスの拡張子を含まないファイル名を取得する。

パラメータ

path

<String>

戻り値

<String>

public fn GetFullPath

絶対パスを取得する。

パラメータ

path

<String>

絶対パスまたは相対パス。

戻り値

<String>

補足

相対パスを使用する場合はベースディレクトリの実体が存在する必要がある。

public fn GetInvalidFileNameChars

ファイル名に使用できない文字の配列を取得する。

戻り値

<Array[<String>]>

public fn GetInvalidPathChars

パス名に使用できない文字の配列を取得する。

戻り値

<Array[<String>]>

public fn GetPathRoot

パスのルートディレクトリ情報を取得する。

パラメータ

path

<String>

戻り値

<String>

補足

パスにルートディレクトリ情報が含まれていない場合は""を返す。

public fn GetRandomFileName

ランダムなファイル名を取得する。

戻り値

<String>

public fn HasExtension

パスに拡張子が含まれているかどうかを判定する。

戻り値

<BooleanClass>

public fn IsPathRooted

パスにルートが含まれているかどうかを判定する。

戻り値

<BooleanClass>

public fn SetBaseDirectory

パラメータ

path

<String>

戻り値

<OkClass>

public fn TrimEndSeparator

末尾にある区切り文字を全て削除する。

パラメータ

path

<String>

戻り値

<String>

補足

ルートディレクトリの場合は何もしない。

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

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