「Pathクラス」の版間の差分
細 (タイプミス) |
細 (差し戻し) |
||
(19人の利用者による、間の146版が非表示) | |||
1行目: | 1行目: | ||
''' | '''Pathクラス'''は、ファイルパスを格納した[[Stringクラス|String]]インスタンスに対して、さまざまなメソッドを提供します。 | ||
== クラスの機能 == | == クラスの機能 == | ||
=== 定数 === | === 定数 === | ||
==== AltDirectorySeparatorChar ==== | ==== AltDirectorySeparatorChar ==== | ||
Static AltDirectorySeparatorChar As | Static AltDirectorySeparatorChar As Char | ||
ディレクトリを区切る代替文字を表します。デフォルトで、Asc("/")が指定されています。 | |||
==== DirectorySeparatorChar ==== | ==== DirectorySeparatorChar ==== | ||
Static DirectorySeparatorChar As Char | |||
ディレクトリを区切る文字を表します。デフォルトで、Asc("\")が指定されています。 | |||
==== PathSeparator ==== | ==== PathSeparator ==== | ||
Static PathSeparator As Char | |||
特に環境変数でパスを区切る文字を表します。デフォルトで、Asc(";")が指定されています。 | |||
==== VolumeSeparatorChar ==== | ==== VolumeSeparatorChar ==== | ||
Static VolumeSeparatorChar As Char | |||
ボリュームを区切る文字を表します。デフォルトで、Asc(":")が指定されています。 | |||
=== メソッド === | === メソッド === | ||
25行目: | 25行目: | ||
:パスを指定します。 | :パスを指定します。 | ||
;戻り値 | ;戻り値 | ||
:pathのファイル名の部分を、[[ | :pathのファイル名の部分を、[[Stringクラス|String]]インスタンスで返します。 | ||
==== GetFileNameWithoutExtension ==== | ==== GetFileNameWithoutExtension ==== | ||
33行目: | 33行目: | ||
:パスを指定します。 | :パスを指定します。 | ||
;戻り値 | ;戻り値 | ||
:pathの拡張子を除いたファイル名の部分を、[[ | :pathの拡張子を除いたファイル名の部分を、[[Stringクラス|String]]インスタンスで返します。 | ||
==== GetRandomFileName ==== | ==== GetRandomFileName ==== | ||
39行目: | 39行目: | ||
Static Function GetRandomFileName() As String | Static Function GetRandomFileName() As String | ||
;戻り値 | ;戻り値 | ||
:ランダムなファイル名を、[[ | :ランダムなファイル名を、[[Stringクラス|String]]インスタンスで返します。 | ||
まだ厳密に実装されていません。 | まだ厳密に実装されていません。 | ||
48行目: | 48行目: | ||
:パスを指定します。 | :パスを指定します。 | ||
;戻り値 | ;戻り値 | ||
:pathの拡張子の部分を、[[ | :pathの拡張子の部分を、[[Stringクラス|String]]インスタンスで返します。 | ||
先頭の"."を含む文字列が返ります。 | 先頭の"."を含む文字列が返ります。 | ||
59行目: | 59行目: | ||
:先頭の"."を含む、新しい拡張子を指定します。 | :先頭の"."を含む、新しい拡張子を指定します。 | ||
;戻り値 | ;戻り値 | ||
:pathの拡張子部分を、extensionで指定した拡張子に変更し、[[ | :pathの拡張子部分を、extensionで指定した拡張子に変更し、[[Stringクラス|String]]インスタンスで返します。 | ||
==== HasExtension ==== | ==== HasExtension ==== | ||
指定したパスの拡張子があるかどうかを返します。 | 指定したパスの拡張子があるかどうかを返します。 | ||
Static Function HasExtension(ByRef path As String) As | Static Function HasExtension(ByRef path As String) As Boolean | ||
;path | ;path | ||
:パスを指定します。 | :パスを指定します。 | ||
;戻り値 | ;戻り値 | ||
: | :拡張子がある場合はTrue、それ以外はFalseを返します。 | ||
==== GetTempFileName ==== | ==== GetTempFileName ==== | ||
73行目: | 73行目: | ||
Static Function GetTempFileName() As String | Static Function GetTempFileName() As String | ||
;戻り値 | ;戻り値 | ||
:作成した一時ファイルのパスを、[[ | :作成した一時ファイルのパスを、[[Stringクラス|String]]インスタンスで返します。 | ||
未実装です。 | 未実装です。 | ||
80行目: | 80行目: | ||
Static Function GetTempPath() As String | Static Function GetTempPath() As String | ||
;戻り値 | ;戻り値 | ||
:一時フォルダのパスを、[[ | :一時フォルダのパスを、[[Stringクラス|String]]インスタンスで返します。 | ||
==== GetFullPath ==== | ==== GetFullPath ==== | ||
88行目: | 88行目: | ||
:パスを指定します。 | :パスを指定します。 | ||
;戻り値 | ;戻り値 | ||
:pathを絶対パスにした、[[ | :pathを絶対パスにした、[[Stringクラス|String]]インスタンスを返します。 | ||
絶対パスは、GetCurrentDirectory()から得られた情報を元に作成されます。また、すでにpathが絶対パスであった場合、戻り値はpathとなります。 | |||
==== GetDirectoryName ==== | ==== GetDirectoryName ==== | ||
96行目: | 97行目: | ||
:パスを指定します。 | :パスを指定します。 | ||
;戻り値 | ;戻り値 | ||
:pathのひとつ上のフォルダのパスが、[[String | :pathのひとつ上のフォルダのパスが、[[Stringクラス|String]]インスタンスで返ります。pathがルートディレクトリを示している場合、戻り値は[[Stringクラス#Empty|String.Empty]]となります。 | ||
==== GetPathRoot ==== | ==== GetPathRoot ==== | ||
104行目: | 105行目: | ||
:パスを指定します。 | :パスを指定します。 | ||
;戻り値 | ;戻り値 | ||
:pathのルートディレクトリが、[[ | :pathのルートディレクトリが、[[Stringクラス|String]]インスタンスで返ります。pathにルートディレクトリが含まれなかった場合、空の文字列が返ります。 | ||
==== IsPathRooted ==== | ==== IsPathRooted ==== | ||
指定したパスに、ルートディレクトリが含まれるかどうかを返します。 | 指定したパスに、ルートディレクトリが含まれるかどうかを返します。 | ||
Static Function IsPathRooted(path As String) As | Static Function IsPathRooted(path As String) As Boolean | ||
;path | ;path | ||
:パスを指定します。 | :パスを指定します。 | ||
;戻り値 | ;戻り値 | ||
: | :pathにルートディレクトリが含まれているならTrue、それ以外はFalseです。 | ||
==== Combine ==== | ==== Combine ==== | ||
122行目: | 123行目: | ||
:path1に続く、パスを指定します。 | :path1に続く、パスを指定します。 | ||
;戻り値 | ;戻り値 | ||
:path1にpath2を連結させた、[[ | :path1にpath2を連結させた、[[Stringクラス|String]]インスタンスが返ります。path1の最後が、パス区切り文字"\"で終わっていなかった場合、path1とpath2の間に、"\"を追加します。 | ||
== 備考 == | == 備考 == | ||
Pathクラスは、Windowsファイルパスを想定して作られています。Pathクラスのメソッドを実行する際、パスが正しい値かチェックされ、無効な文字が含まれている場合、[[IOExceptionクラス|IOException]]が発生します。 | |||
[[Category:System.IO名前空間]] |
2011年1月15日 (土) 17:53時点における最新版
Pathクラスは、ファイルパスを格納したStringインスタンスに対して、さまざまなメソッドを提供します。
クラスの機能
定数
AltDirectorySeparatorChar
Static AltDirectorySeparatorChar As Char
ディレクトリを区切る代替文字を表します。デフォルトで、Asc("/")が指定されています。
DirectorySeparatorChar
Static DirectorySeparatorChar As Char
ディレクトリを区切る文字を表します。デフォルトで、Asc("\")が指定されています。
PathSeparator
Static PathSeparator As Char
特に環境変数でパスを区切る文字を表します。デフォルトで、Asc(";")が指定されています。
VolumeSeparatorChar
Static VolumeSeparatorChar As Char
ボリュームを区切る文字を表します。デフォルトで、Asc(":")が指定されています。
メソッド
GetFileName
指定したパスの、ファイル名の部分だけを取得します。
Static Function GetFileName(path As String) As String
- path
- パスを指定します。
- 戻り値
- pathのファイル名の部分を、Stringインスタンスで返します。
GetFileNameWithoutExtension
指定したパスの、拡張子を除いたファイル名の部分だけを取得します。
Static Function GetFileNameWithoutExtension(path As String) As String
- path
- パスを指定します。
- 戻り値
- pathの拡張子を除いたファイル名の部分を、Stringインスタンスで返します。
GetRandomFileName
ランダムなファイル名を取得します。
Static Function GetRandomFileName() As String
- 戻り値
- ランダムなファイル名を、Stringインスタンスで返します。
まだ厳密に実装されていません。
GetExtension
指定したパスの、拡張子の部分だけを取得します。
Static Function GetExtension(path As String) As String
- path
- パスを指定します。
- 戻り値
- pathの拡張子の部分を、Stringインスタンスで返します。
先頭の"."を含む文字列が返ります。
ChangeExtension
指定したパスの、拡張子を変更します。
Static Function ChangeExtension(path As String, extension As String) As String
- path
- パスを指定します。
- extension
- 先頭の"."を含む、新しい拡張子を指定します。
- 戻り値
- pathの拡張子部分を、extensionで指定した拡張子に変更し、Stringインスタンスで返します。
HasExtension
指定したパスの拡張子があるかどうかを返します。
Static Function HasExtension(ByRef path As String) As Boolean
- path
- パスを指定します。
- 戻り値
- 拡張子がある場合はTrue、それ以外はFalseを返します。
GetTempFileName
一時ファイルを作成し、そのパスを返します。
Static Function GetTempFileName() As String
- 戻り値
- 作成した一時ファイルのパスを、Stringインスタンスで返します。
未実装です。
GetTempPath
システムの一時フォルダのパスを取得します。
Static Function GetTempPath() As String
- 戻り値
- 一時フォルダのパスを、Stringインスタンスで返します。
GetFullPath
指定したパスを、絶対パスにして返します。
Static Function GetFullPath(path As String) As String
- path
- パスを指定します。
- 戻り値
- pathを絶対パスにした、Stringインスタンスを返します。
絶対パスは、GetCurrentDirectory()から得られた情報を元に作成されます。また、すでにpathが絶対パスであった場合、戻り値はpathとなります。
GetDirectoryName
指定したパスの、ひとつ上のディレクトリ(パスが示すファイル,ディレクトリが入っているフォルダ)のパスを取得します。
Static Function GetDirectoryName(path As String) As String
- path
- パスを指定します。
- 戻り値
- pathのひとつ上のフォルダのパスが、Stringインスタンスで返ります。pathがルートディレクトリを示している場合、戻り値はString.Emptyとなります。
GetPathRoot
指定したパスの、ルートディレクトリを取得します。
Static Function GetPathRoot(path As String) As String
- path
- パスを指定します。
- 戻り値
- pathのルートディレクトリが、Stringインスタンスで返ります。pathにルートディレクトリが含まれなかった場合、空の文字列が返ります。
IsPathRooted
指定したパスに、ルートディレクトリが含まれるかどうかを返します。
Static Function IsPathRooted(path As String) As Boolean
- path
- パスを指定します。
- 戻り値
- pathにルートディレクトリが含まれているならTrue、それ以外はFalseです。
Combine
指定した2つのパスを連結させます。
Static Function Combine(path1 As String, path2 As String) As String
- path1
- 先頭のパスを指定します。
- path2
- path1に続く、パスを指定します。
- 戻り値
- path1にpath2を連結させた、Stringインスタンスが返ります。path1の最後が、パス区切り文字"\"で終わっていなかった場合、path1とpath2の間に、"\"を追加します。
備考
Pathクラスは、Windowsファイルパスを想定して作られています。Pathクラスのメソッドを実行する際、パスが正しい値かチェックされ、無効な文字が含まれている場合、IOExceptionが発生します。