powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Split-Path



NAME
Split-Path

SYNOPSIS
Returns the specified part of a path.

SYNTAX
Split-Path [-IsAbsolute] [-Path] [-Credential ] [-LiteralPath ] [-Resolve] [-Use
Transaction] []

Split-Path [-Leaf] [-Path] [-Credential ] [-LiteralPath ] [-Resolve] [-UseTransa
ction] []

Split-Path [-NoQualifier] [-Path] [-Credential ] [-LiteralPath ] [-Resolve] [-Us
eTransaction] []

Split-Path [-Parent] [-Path] [-Credential ] [-LiteralPath ] [-Resolve] [-UseTran
saction] []

Split-Path [[-Qualifier]] [-Path] [-Credential ] [-LiteralPath ] [-Resolve] [-Us
eTransaction] []


DESCRIPTION
The Split-Path cmdlet returns only the specified part of a path, such as the parent directory, a child directory, o
r a file name. It also can display the items that are referenced by the split path and tell whether the path is rel
ative or absolute.

You can use this cmdlet to display or submit only a selected part of a path.


PARAMETERS
-Credential
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 "Domain01\User01". Or, enter a PSCredential object, such as one generated
by the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.

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

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-IsAbsolute []
Returns TRUE if the path is absolute and FALSE if it is relative. An absolute path has a length greater than ze
ro and does not use a dot ( . ) to indicate the current path.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Leaf []
Returns only the last item or container in the path. For example, in the path "C:\Test\Logs\Pass1.log", it retu
rns only "Pass1.log".

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-LiteralPath
Specifies the paths to be split. Unlike Path, the value of LiteralPath is used exactly as it is typed. No chara
cters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation mark
s. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-NoQualifier []
Returns the path without the qualifier. For the FileSystem or registry providers, the qualifier is the drive of
the provider path, such as C: or HKCU:. For example, in the path "C:\Test\Logs\Pass1.log", it returns only "\
Test\Logs\Pass1.log".

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Parent []
Returns only the parent containers of the item or of the container specified by the path. For example, in the p
ath "C:\Test\Logs\Pass1.log", it returns "C:\Test\Logs". The Parent parameter is the default split location par
ameter.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Path
Specifies the paths to be split. Wildcards are permitted. If the path includes spaces, enclose it in quotation
marks. You can also pipe a path to Split-Path.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Qualifier []
Returns only the qualifier of the specified path. For the FileSystem or registry providers, the qualifier is th
e drive of the provider path, such as C: or HKCU:.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Resolve []
Displays the items that are referenced by the resulting split path instead of displaying the path elements.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-UseTransaction []
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.
For more information, see about_Transactions.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.String
You can pipe a string that contains a path to Split-Path.


OUTPUTS
System.String
The Split-Path cmdlet returns text strings. When you use the Resolve parameter, Split-Path returns a string tha
t describes the location of the items; it does not return objects that represent the items, such as a FileInfo
or RegistryKey object.


NOTES


The split location parameters (Qualifier, Parent, Leaf, and NoQualifier) are exclusive. You can use only one in
each command.

The cmdlets that contain the Path noun (the Path cmdlets) manipulate path names and return the names in a conci
se format that all Windows PowerShell providers can interpret. They are designed for use in programs and script
s where you want to display all or part of a path name in a particular format. Use them like you would use Dirn
ame, Normpath, Realpath, Join, or other path manipulators.

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

The Split-Path cmdlet is designed to work with the data exposed by any provider. To list the providers availabl
e in your session, type "Get-PSProvider". For more information, see about_Providers.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>split-path "HKCU:\Software\Microsoft" -qualifier

HKCU:


Description
-----------
This command returns only the qualifier (the drive) of the path.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>split-path "C:\Test\Logs\*.log" -leaf -resolve

Pass1.log
Pass2.log
...


Description
-----------
This command displays the files that are referenced by the split path. Because this path is split to the last item
(the "leaf"), only the file names of the paths are displayed.

The Resolve parameter tells Split-Path to display the items that the split path references, instead of displaying t
he split path.

Like all Split-Path commands, this command returns strings. It does not return FileInfo Objects representing the fi
les.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>split-path "C:\WINDOWS\system32\WindowsPowerShell\V1.0\about_*.txt"

C:\WINDOWS\system32\WindowsPowerShell\V1.0


Description
-----------
This command returns only the parent containers of the path. Because it does not include any parameters to specify
the split, Split-Path uses the split location default, which is Parent.





-------------------------- EXAMPLE 4 --------------------------

C:\PS>split-path ".\My Pictures\*.jpg" -IsAbsolute

False


Description
-----------
This command determines whether the path is relative or absolute. In this case, because the path is relative to the
current directory, which is represented by a dot (.), it returns FALSE ($false).





-------------------------- EXAMPLE 5 --------------------------

C:\PS>set-location (split-path $profile)

PS C:\Documents and Settings\juneb\My Documents\WindowsPowerShell>


Description
-----------
This command changes your location to the directory that contains the Windows PowerShell profile.
The command in parentheses uses the Split-Path cmdlet to return only the parent of the path stored in the built-in
$Profile variable. (The Parent parameter is the default split location parameter, so you can omit it from the comma
nd.) The parentheses direct Windows PowerShell to execute the command first. This is a handy way to navigate to a d
irectory with a long path name.





-------------------------- EXAMPLE 6 --------------------------

C:\PS>'C:\Documents and Settings\User01\My Documents\My Pictures' | split-path

C:\Documents and Settings\User01\My Documents


Description
-----------
This command uses a pipeline operator (|) to send a path to the Split-Path cmdlet. The path is enclosed in quotatio
n marks to indicate that it is a single token.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113404
about_Providers
Test-Path
Convert-Path
Resolve-Path
Join-Path