Test-Path

モジュール:

Microsoft.PowerShell.Management

パスのすべての要素が存在するかどうかを確認します。

構文

Test-Path
    [-Path] <string[]>
    [-Filter <string>]
    [-Include <string[]>]
    [-Exclude <string[]>]
    [-PathType <TestPathType>]
    [-IsValid]
    [-Credential <pscredential>]
    [-UseTransaction]
    [-OlderThan <datetime>]
    [-NewerThan <datetime>]
    [<CommonParameters>]

Test-Path
    -LiteralPath <string[]>
    [-Filter <string>]
    [-Include <string[]>]
    [-Exclude <string[]>]
    [-PathType <TestPathType>]
    [-IsValid]
    [-Credential <pscredential>]
    [-UseTransaction]
    [-OlderThan <datetime>]
    [-NewerThan <datetime>]
    [<CommonParameters>]

Test-Path
    [-Path] <string[]>
    [-Filter <string>]
    [-Include <string[]>]
    [-Exclude <string[]>]
    [-PathType <TestPathType>]
    [-IsValid]
    [-Credential <pscredential>]
    [-UseTransaction]
    [<CommonParameters>]

Test-Path
    -LiteralPath <string[]>
    [-Filter <string>]
    [-Include <string[]>]
    [-Exclude <string[]>]
    [-PathType <TestPathType>]
    [-IsValid]
    [-Credential <pscredential>]
    [-UseTransaction]
    [<CommonParameters>]

説明

Test-Path コマンドレットは、パスのすべての要素が存在するかどうかを決定します。 すべての要素が存在する場合は $true を返し、存在しない場合は $false します。 また、パス構文が有効かどうか、およびパスがコンテナーまたはターミナル要素またはリーフ要素につながるかどうかを判断することもできます。 Path が空白または空の文字列の場合、コマンドレットは$falseを返します。 Pathが$null、$nullの配列、または空の配列である場合、コマンドレットは終了しないエラーを返します。

例

例 1: パスをテストする

Test-Path -Path "C:\Documents and Settings\DavidC"

True

このコマンドは、 C: ディレクトリ、 Documents and Settings ディレクトリ、 DavidC ディレクトリなど、パス内のすべての要素が存在するかどうかを確認します。 存在しない場合、コマンドレットは $falseを返します。 それ以外の場合は $trueを返します。

例 2: プロファイルのパスをテストする

Test-Path -Path $profile

False

Test-Path -Path $profile -IsValid

True

これらのコマンドは、PowerShell プロファイルのパスをテストします。

最初のコマンドは、パス中のすべての要素が存在するかどうかを判断します。 2 番目のコマンドは、パスの構文が正しいかどうかを確認します。 この場合、パスは $falseされていますが、構文は正しい $trueです。 これらのコマンドでは、プロファイルが存在しない場合でも、プロファイルの場所を指す自動変数である $profileを使用します。

自動変数の詳細については、 about_Automatic_Variablesを参照してください。

例 3: 指定した型以外にファイルがあるかどうかを確認する

Test-Path -Path "C:\CAD\Commercial Buildings\*" -Exclude *.dwg

False

このコマンドは、.dwg ファイル以外の Commercial Buildings ディレクトリにファイルがあるかどうかを確認します。

このコマンドでは、 Path パラメーターを使用してパスを指定します。 パスにはスペースが含まれているため、パスは引用符で囲まれます。 パスの末尾のアスタリスクは、Commercial Building ディレクトリの内容を表します。 このような長いパスでは、パスの最初の数文字を入力し、TAB キーを使用してパスを完了します。

このコマンドは、 Exclude パラメーターを指定して、評価から除外するファイルを指定します。

この場合、ディレクトリには.dwgファイルのみが含まれているため、結果は $false。

例 4: ファイルを確認する

Test-Path -Path $profile -PathType leaf

True

このコマンドは、 $profile 変数に格納されているパスがファイルにつながるかどうかを確認します。 この場合、PowerShell プロファイルは .ps1 ファイルであるため、コマンドレットは $trueを返します。

例 5: レジストリのパスを確認する

これらのコマンドは、PowerShell レジストリ プロバイダーで Test-Path を使用します。

最初のコマンドは、 Microsoft.PowerShell レジストリ キーのレジストリ パスがシステム上で正しいかどうかをテストします。 PowerShell が正しくインストールされている場合、コマンドレットは $trueを返します。

重要

Test-Path は、すべての PowerShell プロバイダーで正しく動作しません。 たとえば、 Test-Path を使用してレジストリ キーのパスをテストできますが、レジストリ エントリのパスをテストするために使用すると、レジストリ エントリが存在する場合でも常に $falseが返されます。

Test-Path -Path "HKLM:\Software\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell"

True

Test-Path -Path "HKLM:\Software\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell\ExecutionPolicy"

False

例 6: ファイルが指定した日付より新しいかどうかをテストする

このコマンドは、 NewerThan 動的パラメーターを使用して、コンピューター上の PowerShell.exe ファイルが July 13, 2009よりも新しいかどうかを判断します。

NewerThan パラメーターは、ファイル システム ドライブでのみ機能します。

Test-Path $pshome\PowerShell.exe -NewerThan "July 13, 2009"

True

例 7: 値として null を持つパスをテストする

null、nullの配列、または空の配列に対して返されるエラーは、終了しないエラーです。 -ErrorAction SilentlyContinueを使用して抑制できます。 次の例は、 NullPathNotPermitted エラーを返すすべてのケースを示しています。

Test-Path $null
Test-Path $null, $null
Test-Path @()

Test-Path : Cannot bind argument to parameter 'Path' because it is null.
At line:1 char:11
+ Test-Path $null
+           ~~~~~
    + CategoryInfo          : InvalidData: (:) [Test-Path], ParameterBindingValidationException
    + FullyQualifiedErrorId : ParameterArgumentValidationErrorNullNotAllowed,Microsoft.PowerShell.Commands.TestPathCommand

例 8: 値として空白文字を含むパスをテストする

Path パラメーターに空白文字列を指定すると、$trueが返されます。 空の文字列が指定されると、 Test-Path はエラーを返します。 次の例は、空白と空の文字列を示しています。

Test-Path ' '
Test-Path ''

True
Test-Path : Cannot bind argument to parameter 'Path' because it is an empty string.
At line:1 char:11
+ Test-Path ''
+           ~~
    + CategoryInfo          : InvalidData: (:) [Test-Path], ParameterBindingValidationException
    + FullyQualifiedErrorId : ParameterArgumentValidationErrorEmptyStringNotAllowed,Microsoft.PowerShell.Commands.TestPathCommand

例 9: 無効なドライブがある可能性があるパスをテストする

ドライブ仕様を含むパスをテストすると、ドライブが存在しない場合、パスの有効性のテストは失敗します。 この問題を回避するには、ドライブの前にプロバイダー名を付けることができます。

Test-Path -IsValid Z:\abc.txt
Test-Path -IsValid FileSystem::Z:\abc.txt

False
True

パラメーター

-Credential

Note

このパラメーターは、PowerShell でインストールされているプロバイダーではサポートされていません。 別のユーザーを偽装したり、このコマンドレットの実行時に資格情報を昇格したりするには、 Invoke-Command を使用します。

型:	PSCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Exclude

このコマンドレットが省略する項目を指定します。 このパラメーターの値は、 Path パラメーターを修飾します。 パス要素またはパターン ( *.txtなど) を入力します。 ワイルドカード文字を使用できます。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	True

-Filter

プロバイダーの形式または言語でフィルターを指定します。 このパラメーターの値は、 Path パラメーターを修飾します。 ワイルドカード文字の使用を含むフィルターの構文は、プロバイダーによって異なります。 フィルターは他のパラメーターよりも効率的です。プロバイダーは、取得後に PowerShell でオブジェクトをフィルター処理するのではなく、オブジェクトを取得するときにフィルターを適用するためです。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	True

-Include

このコマンドレットがテストするパスを指定します。 このパラメーターの値は、 Path パラメーターを修飾します。 パス要素またはパターン ( *.txtなど) を入力します。 ワイルドカード文字を使用できます。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	True

-IsValid

このコマンドレットは、パスの要素が存在するかどうかに関係なく、パスの構文をテストすることを示します。 このコマンドレットは、パス構文が有効な場合は $true を返し、有効でない場合は $false します。 テスト対象のパスにドライブ仕様が含まれている場合、コマンドレットはドライブが存在しない場合に false を返します。 テストするドライブ プロバイダーがわからないため、PowerShell は false を返します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-LiteralPath

テストするパスを指定します。 Path とは異なり、LiteralPath パラメーターの値は、型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 PowerShell でエスケープ シーケンスとして解釈できる文字がパスに含まれている場合は、パスを一重引用符で囲んで解釈されないようにする必要があります。

型:	String[]
Aliases:	PSPath
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-NewerThan

これは、 FileSystem プロバイダーによって使用できる動的パラメーターです。

DateTime オブジェクトとして時刻を指定します。

PowerShell 7.5 より前のコマンドレットでは、次の処理は無視されます。

• このパラメーターは、Any以外の値として PathType を指定する場合に使用します。
• このパラメーターで使用する場合は、 OlderThan パラメーター。
• このパラメーターは、 Path がディレクトリを指している場合に指定します。

PowerShell 7.5 以降では、このパラメーターを PathType パラメーターの任意の値と共に使用して、 OlderThan パラメーターで日付範囲をテストし、ディレクトリの有効期間をテストできます。

詳細については、「 about_FileSystem_Provider」を参照してください。

型:	Nullable<T>[[DateTime]]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-OlderThan

これは、 FileSystem プロバイダーによって使用できる動的パラメーターです。

DateTime オブジェクトとして時刻を指定します。

PowerShell 7.5 より前のコマンドレットでは、次の処理は無視されます。

• このパラメーターは、Any以外の値として PathType を指定する場合に使用します。
• このパラメーターは、 NewerThan パラメーターと共に使用します。
• このパラメーターは、 Path がディレクトリを指している場合に指定します。

PowerShell 7.5 以降では、このパラメーターを PathType パラメーターの任意の値と共に使用して、 NewerThan パラメーターで日付範囲をテストし、ディレクトリの有効期間をテストできます。

詳細については、「 about_FileSystem_Provider」を参照してください。

型:	Nullable<T>[[DateTime]]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Path

テストするパスを指定します。 ワイルドカード文字を使用できます。 パスにスペースが含まれる場合は、二重引用符で囲みます。

型:	String[]
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-PathType

パス内の最終的な要素の型を指定します。 このコマンドレットは、要素が指定した型の場合は $true を返し、そうでない場合は $false します。 このパラメーターの有効値は、次のとおりです。

• Container - ディレクトリやレジストリ キーなど、他の要素を含む要素。
• Leaf - ファイルなどの他の要素を含まない要素。
• Any - コンテナーまたはリーフ。

パスの最終要素が特定の種類かどうかを示します。

注意事項

PowerShell バージョン 6.1.2 までは、 IsValid スイッチと PathType スイッチが同時に指定されている場合、 Test-Path コマンドレットは PathType スイッチを無視し、パスの種類を検証せずに構文パスのみを検証します。

issue #8607 によるとこの動作を修正することは、将来のバージョンで重大な変更になる可能性があります。この場合、IsValid スイッチと PathType スイッチは別々のパラメーター セットに属しているため、この混乱を避けるために一緒に使用することはできません。

型:	TestPathType
Aliases:	Type
指定可能な値:	Any, Container, Leaf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UseTransaction

アクティブなトランザクションのコマンドが含まれます。 このパラメーターは、トランザクションが進行中の場合のみ有効です。 詳細については、 about_Transactionsを参照してください。

型:	SwitchParameter
Aliases:	usetx
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

String

リテラル パスではなくパスを含む文字列をこのコマンドレットにパイプできます。

出力

Boolean

このコマンドレットは、 Boolean 値を返します。

メモ

Path名詞 (Path コマンドレット) を含むコマンドレットは、パスを操作し、すべての PowerShell プロバイダーが解釈できる簡潔な形式で名前を返します。 これらは、パスのすべてまたは一部を特定の形式で表示するプログラムやスクリプトで使用するように設計されています。 Dirname、Normpath、Realpath、Join、またはその他のパス マニピュレータを使用する場合と同様に使用します。

Test-Pathは、任意のプロバイダーによって公開されるデータを操作するように設計されています。 セッションで使用可能なプロバイダーを一覧表示するには、「 Get-PSProvider」と入力します。 詳細については、「 about_Providers」を参照してください。

関連リンク

• Convert-Path
• Join-Path
• Resolve-Path
• Split-Path