Test-Path

Syntax

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>]

Description

The Test-Path cmdlet determines whether all elements of the path exist. It returns $True if all elements exist and $False if any are missing. It can also tell whether the path syntax is valid and whether the path leads to a container or a terminal or leaf element.

Examples

Example 1: Test a path

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

This command checks whether all elements in the path exist, that is, the C: directory, the Documents and Settings directory, and the DavidC directory. If any are missing, the cmdlet returns $False. Otherwise, it returns $True.

Example 2: Test the path of a profile

PS C:\> Test-Path -Path $profile

PS C:\> Test-Path -Path $profile -IsValid

These commands test the path of the Windows PowerShell profile.

The first command determines whether all elements in the path exist. The second command determines whether the syntax of the path is correct. In this case, the path is $False, but the syntax is correct ($True). These commands use $profile, the automatic variable that points to the location for the profile, even if the profile does not exist.

For more information about automatic variables, see about_Automatic_Variables.

Example 3: Check whether there are any files besides a specified type

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

This command checks whether there are any files in the Commercial Buildings directory other than .dwg files.

The command uses the Path parameter to specify the path. Because the path includes a space, the path is enclosed in quotation marks. The asterisk at the end of the path indicates the contents of the Commercial Building directory. With long paths, such as this one, type the first few letters of the path, and then use the TAB key to complete the path.

The command specifies the Exclude parameter to specify files that will be omitted from the evaluation.

In this case, because the directory contains only .dwg files, the result is $False.

Example 4: Check for a file

PS C:\> Test-Path -Path $profile -PathType leaf

This command checks whether the path stored in the $profile variable leads to a file. In this case, because the Windows PowerShell profile is a .ps1 file, the cmdlet returns $True.

Example 5: Check paths in the Registry

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

True

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

False

These commands use Test-Path with the Windows PowerShell registry provider.

The first command tests whether the registry path of the Microsoft.PowerShell registry key is correct on the system. If Windows PowerShell is installed correctly, the cmdlet returns $True.

Test-Path does not work correctly with all Windows PowerShell providers. For example, you can use Test-Path to test the path of a registry key, but if you use it to test the path of a registry entry, it always returns $False, even if the registry entry is present.

Required Parameters

Optional Parameters

Inputs

System.String

You can pipe a string that contains a path, but not a literal path, to this cmdlet.

Outputs

System.Boolean

The cmdlet returns a Boolean value.

Notes

• The cmdlets that contain the Path noun (the Path cmdlets) work with path names and return the names in a concise format that all Windows PowerShell providers can interpret. They are designed for use in programs and scripts where you want to display all or part of a path name in a particular format. Use them as you would use Dirname , Normpath , Realpath , Join , or other path manipulators.

  You can use the Path cmdlets with several providers, including the FileSystem, Registry, and Certificate providers.

  Test-Path is designed to work with the data exposed by any provider. To list the providers available in your session, type Get-PSProvider . For more information, see about_Providers.

*

Related Links

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