Test-Path
判斷路徑的所有元素是否存在。
語法
Test-Path
[-Path] <String[]>
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-PathType <TestPathType>]
[-IsValid]
[-Credential <PSCredential>]
[-OlderThan <DateTime>]
[-NewerThan <DateTime>]
[<CommonParameters>]
Test-Path
-LiteralPath <String[]>
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-PathType <TestPathType>]
[-IsValid]
[-Credential <PSCredential>]
[-OlderThan <DateTime>]
[-NewerThan <DateTime>]
[<CommonParameters>]
Test-Path
[-Path] <string[]>
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-PathType <TestPathType>]
[-IsValid]
[-Credential <pscredential>]
[<CommonParameters>]
Test-Path
-LiteralPath <string[]>
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-PathType <TestPathType>]
[-IsValid]
[-Credential <pscredential>]
[<CommonParameters>]
Description
Test-Path
小命令會判斷路徑的所有元素是否存在。 如果所有元素都存在,則會傳回 $true
;如果有任何元素遺漏,則會傳回 $false
。 它也可以判斷路徑語法是否有效,以及路徑是否通向容器、終端元素或葉節點。 如果 Path 是空白或空字串,則 Cmdlet 會傳回 $false
。 如果 Path 是 $null
、$null
陣列或空陣列,Cmdlet 會傳回非終止錯誤。
範例
範例 1:測試路徑
Test-Path -Path "C:\Documents and Settings\DavidC"
True
此命令會檢查路徑中的所有專案是否存在,包括 C:
目錄、Documents and Settings
目錄和 DavidC
目錄。 如果遺漏任何項目,cmdlet 會傳回 $false
。 否則,它會傳回 $true
。
範例 2:檢測設定檔的路徑
Test-Path -Path $PROFILE
False
Test-Path -Path $PROFILE -IsValid
True
這些命令會測試 PowerShell 配置檔的路徑。
第一個命令會判斷路徑中的所有專案是否存在。 第二個命令會判斷路徑的語法是否正確。 在這種情況下,路徑是 $false
,但語法正確 $true
。 這些命令會使用 $PROFILE
,這是指向配置檔位置的自動變數,即使配置檔不存在也一樣。
如需自動變數的詳細資訊,請參閱 about_Automatic_Variables。
範例 3:檢查指定的類型之外是否有任何檔案
Test-Path -Path "C:\CAD\Commercial Buildings\*" -Exclude *.dwg
False
此命令會檢查「商業建築」目錄中有無 .dwg 檔案以外的其他檔案。
命令會使用 Path 參數來指定路徑。 因為路徑包含空格,因此路徑會以引弧括住。 路徑結尾的星號表示商業建築目錄的內容。 使用長路徑,例如這個路徑,輸入路徑的前幾個字母,然後使用 TAB 鍵來完成路徑。
命令會指定要從評估中省略的檔案 Exclude 參數。
在此情況下,因為目錄只包含.dwg檔案,所以結果會 $false
。
範例 4:檢查檔案
Test-Path -Path $PROFILE -PathType Leaf
True
此命令會檢查儲存在 $PROFILE
變數中的路徑是否會導致檔案。 在這裡情況下,因為 PowerShell 設定檔是 .ps1
檔案,因此 Cmdlet 會傳回 $true
。
範例 5:檢查登錄中的路徑
這些命令會搭配PowerShell登錄提供者使用 Test-Path
。
第一個命令會測試系統上 Microsoft.PowerShell 登錄機碼的登錄路徑是否正確。 如果正確安裝 PowerShell,Cmdlet 會傳回 $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 和 OlderThan 動態參數來判斷電腦上的 pwsh.exe
檔案是否比上周更新 July 13, 2009
還舊。
NewerThan 和 OlderThan 參數只能在文件系統磁碟驅動器中運作。
Get-Command pwsh |
Select-Object -ExpandProperty Path |
Test-Path -NewerThan "July 13, 2009" -OlderThan (Get-Date).AddDays(-7)
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 參數提供空格符字串時,它會傳回 $false
。 這是 Windows PowerShell 5.1 的變更。 提供空字串時,Test-Path
傳回錯誤。
下列範例顯示空格元和空字串。
Test-Path ' '
Test-Path ''
False
False
範例 9:測試可能具有無效磁碟驅動器的路徑
當您測試包含磁碟驅動器規格的路徑時,如果磁碟驅動器不存在,測試路徑的有效性就會失敗。 您可以在磁碟驅動器前面加上提供者名稱,以解決此問題。
Test-Path -IsValid Z:\abc.txt
Test-Path -IsValid FileSystem::Z:\abc.txt
False
True
參數
-Credential
注意
任何與 PowerShell 一起安裝的提供者都不支援此參數。 若要模擬其他使用者,或在執行此 Cmdlet 時提升您的認證,請使用 Invoke-Command。
類型: | PSCredential |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Exclude
指定這個 Cmdlet 會省略的項目。 此參數的值會限定 path 參數。 輸入路徑元素或模式,例如 *.txt
。 允許通配符。
類型: | String[] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | True |
-Filter
以提供者的格式或語言指定篩選。 此參數的值會限定 path 參數。 篩選的語法,包括使用通配符,取決於提供者。 篩選比其他參數更有效率,因為提供者在擷取物件時會套用它們,而不是讓PowerShell在擷取對象之後篩選物件。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | True |
-Include
指定此 Cmdlet 測試的路徑。 此參數的值會限定 path 參數。 輸入路徑元素或模式,例如 *.txt
。 允許通配符。
類型: | String[] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | True |
-IsValid
指示此 Cmdlet 不論路徑的元素是否存在,都會測試路徑的語法。 如果路徑語法有效,則此 Cmdlet 會傳回 $true
,如果路徑語法無效,則傳回 $false
。 如果所測試的路徑包含磁碟驅動器規格,當磁碟驅動器不存在時,Cmdlet 會傳回 false。 PowerShell 會傳回 false,因為它不知道要測試哪一個磁碟驅動器提供者。
注意
在 .NET 2.1 中引進了路徑 API 的重大變更。 這些方法不再檢查無效的路徑字元。 這項變更導致PowerShell出現回歸錯誤,其中 IsValid 檢查不再測試無效字元。 回歸將在未來的版本中解決。 如需詳細資訊,請參閱 .NET Core 2.1的重大變更。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-LiteralPath
指定要測試的路徑。 與 Path相比,LiteralPath 參數的值會完全按照其輸入的方式使用。 不會將任何字元解譯為通配符。 如果路徑包含可能被 PowerShell 誤解為逸出序列的字元,您必須使用單引號將路徑括起,以避免這些字元被解譯。
類型: | String[] |
別名: | PSPath, LP |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-NewerThan
這是 FileSystem 提供者所提供的動態參數。
將時間指定為 DateTime 物件。
在 PowerShell 7.5 之前,Cmdlet 會忽略:
- 當您將 。
- 搭配此參數使用時,OlderThan 參數。
- 當路徑指向一個目錄時,這個參數將生效。
從 PowerShell 7.5 開始,您可以使用此參數搭配 PathType 參數的任何值、使用 OlderThan 參數測試日期範圍,以及測試目錄的存留期。
如需詳細資訊,請參閱 about_FileSystem_Provider。
類型: | Nullable<T>[[DateTime]] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-OlderThan
這是 FileSystem 提供者所提供的動態參數。
將時間指定為 DateTime 物件。
在 PowerShell 7.5 之前,Cmdlet 會忽略:
- 當您將 。
- 當此參數與 NewerThan 參數一起使用時。
- 當路徑指向一個目錄時,這個參數將生效。
從 PowerShell 7.5 開始,您可以使用此參數搭配 PathType 參數的任何值、使用 NewerThan 參數測試日期範圍,以及測試目錄的存留期。
如需詳細資訊,請參閱 about_FileSystem_Provider。
類型: | Nullable<T>[[DateTime]] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Path
指定要測試的路徑。 允許通配符。 如果路徑包含空格,請以引號括住它。
類型: | String[] |
Position: | 0 |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | True |
-PathType
指定路徑中最後一個項目的類型。 如果專案是指定的型別,則這個 Cmdlet 會傳回 $true
,如果不是,則傳回 $false
。 此參數可接受的值為:
-
Container
- 包含其他項目的元素,例如目錄或登錄機碼。 -
Leaf
- 一個不包含其他元素的元素,例如檔案。 -
Any
- 容器或葉節。
指出路径中的最终元素是否为特定类型。
謹慎
在 PowerShell 版本6.1.2之前,當同時指定 IsValid 和 PathType 開關時,Test-Path
Cmdlet 會忽略 PathType 開關,只會驗證語法路徑而不驗證路徑類型。
根據 問題 #8607,修正此行為可能是未來版本中的重大變更,其中 IsValid 和 PathType 參數屬於個別的參數集,因此無法一起使用以避免這種混淆。
類型: | TestPathType |
別名: | Type |
接受的值: | Any, Container, Leaf |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
輸入
您可以使用管線將包含路徑但不是字面路徑的字串傳送至此 Cmdlet。
輸出
Cmdlet 會傳回 布爾值。
備註
包含 Path 名詞的 Cmdlet(Path Cmdlet)會處理路徑,並以簡潔的格式傳回所有 PowerShell 提供者能夠解析的名稱。 其設計用於您想要以特定格式顯示路徑之所有或部分的程式和腳本中。 像使用 Dirname、Normpath、Realpath、Join或其他路徑操作工具一樣使用它們。
Test-Path
的設計目的是要處理任何提供者所公開的數據。 若要列出工作階段中可用的提供者,請輸入 Get-PSProvider
。 如需詳細資訊,請參閱 about_Providers。