powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-Location



NAME
Set-Location

SYNOPSIS
Sets the current working location to a specified location.

SYNTAX
Set-Location [-LiteralPath] [-PassThru] [-UseTransaction] []

Set-Location [[-Path] ] [-PassThru] [-UseTransaction] []

Set-Location [-StackName ] [-PassThru] [-UseTransaction] []


DESCRIPTION
The Set-Location cmdlet sets the working location to a specified location. That location could be a directory, a su
b-directory, a registry location, or another location stack.


PARAMETERS
-LiteralPath
Specifies a path to the location. The value of the LiteralPath parameter is used exactly as it is typed. No cha
racters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation ma
rks. 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 []
Passes an object representing the location to the pipeline. By default, this cmdlet does not generate any outpu
t.

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

-Path
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
The name of the stack to which the location is being set.

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


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 (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 availa
ble in your session, type "Get-PSProvider". For more information, see about_Providers.


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

C:\PS>set-location HKLM:


Description
-----------
This will set the current location to the one specified; in this case, it is the HKLM provider.





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

C:\PS>set-location env: -passthru

Path
----
Env:\


Description
-----------
This will set the current location to the one specified; in this case, it is the environment variable provider.





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

C:\PS>set-location C:


Description
-----------
This will set the current location to the one specified; in this case, it is the C: drive in the file system provid
er.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113397
about_Providers
Get-Location
Pop-Location
Push-Location