Test-Path

Determines whether all elements of a path exist.
Test-Path [-Path*] <String[]> [-Credential [<PSCredential>]] [-Exclude [<String[]>]] [-Filter [<String>]] [-Include[<String[]>]] [-IsValid] [-NewerThan [<Nullable [System.DateTime]>]] [-OlderThan [<Nullable [System.DateTime]>]][-PathType {Any | Container | Leaf}] [-UseTransaction [<SwitchParameter>]] [<CommonParameters>]
Test-Path [-Credential [<PSCredential>]] [-Exclude [<String[]>]] [-Filter [<String>]] [-Include [<String[]>]][-IsValid] [-NewerThan [<Nullable [System.DateTime]>]] [-OlderThan [<Nullable [System.DateTime]>]] [-Path*Type {Any| Container | Leaf}] -LiteralPath* <String[]> [-UseTransaction [<SwitchParameter>]] [<CommonParameters>]

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.

Parameters
-Credential [<PSCredential>]

Specifies a user account that has permission to perform this action. The default is the current user.

Type a user name, such as User01 or Domain01User01. Or, enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If you type a user name, this cmdlet prompts you for a password.

This parameter is not supported by any providers installed with Windows PowerShell.

-Exclude [<String[]>]

Specifies items that this cmdlet omits. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as “*.txt”. Wildcard characters are permitted.

-Filter [<String>]

Specifies a filter in the format or language of the provider. The value of this parameter qualifies the Path parameter. The syntax of the filter, including the use of wildcard characters, depends on the provider. Filters are more efficient than other parameters, because the provider applies them when it retrieves the objects instead of having Windows PowerShell filter the objects after they are retrieved.

-Include [<String[]>]

Specifies paths that this cmdlet tests. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as “*.txt”. Wildcard characters are permitted.

-IsValid [<SwitchParameter>]

Indicates that this cmdlet tests the syntax of the path, regardless of whether the elements of the path exist. This cmdlet returns $True if the path syntax is valid and $False if it is not.

-LiteralPath <String[]>

Specifies a path to be tested. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.

-NewerThan [<Nullable [System.DateTime]>]

Specify a time as a DateTime object.

-OlderThan [<Nullable [System.DateTime]>]

Specify a time as a DateTime object.

-Path <String[]>

  • This value is required
  • Accepts pipeline input ByValue

Specifies a path to be tested. Wildcard characters are permitted. If the path includes spaces, enclose it in quotation marks.

-PathType [<TestPathType>]

Specifies the type of the final element in the path. This cmdlet returns $True if the element is of the specified type and $False if it is not. The acceptable values for this parameter are:

— Container. An element that contains other elements, such as a directory or registry key.– Leaf. An element that does not contain other elements, such as a file.– Any. Either a container or a leaf. Tells whether the final element in the path is of a particular type.

-UseTransaction [<SwitchParameter>]

  • Default value is false

Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

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.

Examples
  1. Test a path:
    PS C:> Test-Path -Path "C:Documents and SettingsDavidC"
    

    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.

  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.

  3. Check whether there are any files besides a specified type:
    PS C:> Test-Path -Path "C:CADCommercial 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.

  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.

  5. Check paths in the Registry:
    PS C:> Test-Path -Path "HKLM:SoftwareMicrosoftPowerShell1ShellIdsMicrosoft.PowerShell"
    True
    PS C:>  Test-Path -Path "HKLM:SoftwareMicrosoftPowerShell1ShellIdsMicrosoft.PowerShellExecutionPolicy"
    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.

Additional 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