Set-PSFPath

NAME Set-PSFPath



SYNOPSIS

Configures or updates a path under a name.





SYNTAX

Set-PSFPath -Name <String> -Path <String> [<CommonParameters>]



Set-PSFPath -Name <String> -Path <String> -Register [-Scope {UserDefault | UserMandatory | SystemDefault |

SystemMandatory | FileUserLocal | FileUserShared | FileSystem}] [<CommonParameters>]





DESCRIPTION

Configures or updates a path under a name.

The path can be persisted using the "-Register" command.

Paths setup like this can be retrieved using Get-PSFPath.





PARAMETERS

-Name <String>

Name the path should be stored under.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Path <String>

The path that should be returned under the name.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Register [<SwitchParameter>]

Registering a path in order for it to persist across sessions.



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Scope

The configuration scope it should be registered under.

Defaults to UserDefault.

Configuration scopes are the default locations configurations are being stored at.

For more details see:

https://psframework.org/documentation/d ... ation.html



Required? false

Position? named

Default value UserDefault

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



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



PS C:\\>Set-PSFPath -Name 'temp' -Path 'C:\\temp'



Configures C:\\temp as the current temp path. (does not override $env:temp !)











RELATED LINKS