Set-Location
Applies To: Windows PowerShell 2.0
Sets the current working location to a specified location.
Syntax
Set-Location [-LiteralPath] <string> [-PassThru] [-UseTransaction] [<CommonParameters>]
Set-Location [[-Path] <string>] [-PassThru] [-UseTransaction] [<CommonParameters>]
Set-Location [-PassThru] [-StackName <string>] [-UseTransaction] [<CommonParameters>]
Description
The Set-Location cmdlet sets the working location to a specified location. That location could be a directory, a sub-directory, a registry location, or any provider path.
You can also use the StackName parameter of the Set-Location cmdlet to make a named location stack the current location stack. For more information about location stacks, see the Notes.
Parameters
-LiteralPath <string>
Specifies a path to the location. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. 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.
Required? |
true |
Position? |
1 |
Default Value |
|
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns a System.Management.Automation.PathInfo object that represents the location. By default, this cmdlet does not generate any output.
Required? |
false |
Position? |
named |
Default Value |
|
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Path <string>
This parameter is used to specify the path to a new working location.
Required? |
false |
Position? |
1 |
Default Value |
|
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-StackName <string>
Makes the specified location stack the current location stack. Enter a location stack name. To indicate the unnamed default location stack, type "$null" or an empty string ("").
The Location cmdlets act on the current stack unless you use the StackName parameter to specify a different stack.
Required? |
false |
Position? |
named |
Default Value |
|
Accept Pipeline Input? |
true (ByPropertyName) |
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 |
<CommonParameters>
This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.
Inputs and Outputs
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.
Inputs |
System.String You can pipe a string that contains a path (but not a literal path) to Set-Location. |
Outputs |
None or System.Management.Automation.PathInfo When you use the PassThru parameter, Set-Location generates a System.Management.Automation.PathInfo object that represents the location. Otherwise, this cmdlet does not generate any output. |
Notes
The Set-Location cmdlet 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.
A "stack" is a last-in, first-out list in which only the most recently added item is accessible. You add items to a stack in the order that you use them, and then retrieve them for use in the reverse order. Windows PowerShell lets you store provider locations in location stacks. Windows PowerShell creates an unnamed default location stack and you can create multiple named location stacks. If you do not specify a stack name, Windows PowerShell uses the current location stack. By default, the unnamed default location is the current location stack, but you can use the Set-Location cmdlet to change the current location stack.
To manage location stacks, use the Windows PowerShell Location cmdlets, as follows.
-- To add a location to a location stack, use the Push-Location cmdlet.
-- To get a location from a location stack, use the Pop-Location cmdlet.
-- To display the locations in the current location stack, use the Stack parameter of the Get-Location cmdlet. To display the locations in a named location stack, use the StackName parameter of the Get-Location cmdlet.
-- To create a new location stack, use the StackName parameter of the Push-Location cmdlet. If you specify a stack that does not exist, Push-Location creates the stack.
-- To make a location stack the current location stack, use the StackName parameter of the Set-Location cmdlet.
The unnamed default location stack is fully accessible only when it is the current location stack. If you make a named location stack the current location stack, you cannot no longer use Push-Location or Pop-Location cmdlets add or get items from the default stack or use Get-Location command to display the locations in the unnamed stack. To make the unnamed stack the current stack, use the StackName parameter of the Set-Location cmdlet with a value of $null or an empty string ("").
Example 1
C:\PS>set-location HKLM:
PS HKLM:\>
Description
-----------
This command set the current location to the root of the HKLM: drive.
Example 2
C:\PS>set-location env: -passthru
Path
----
Env:\
PS Env:\>
Description
-----------
This command sets the current location to the root of the Env: drive. It uses the Passthru parameter to direct Windows PowerShell to return a PathInfo (System.Management.Automation.PathInfo) object that represents the Env: location.
Example 3
C:\PS>set-location C:
Description
-----------
This command sets the current location C: drive in the file system provider.
Example 4
C:\PS>set-location -stackName WSManPaths
Description
-----------
This command makes the WSManPaths location stack the current location stack.
The location cmdlets use the current location stack unless a different location stack is specified in the command. For information about location stacks, see the Notes.