Get EnvironmentVariable

Get-EnvironmentVariable

SYNOPSIS

Returns the value from an environment variable from a specified target.

SYNTAX

Get-EnvironmentVariable [-Name] <String> [[-FromTarget] <String>] 
 [<CommonParameters>]

DESCRIPTION

Returns the value from an environment variable from a specified target. This command returns $null if the environment variable does not exist.

EXAMPLES

EXAMPLE 1

Get-EnvironmentVariable -Name 'PSModulePath'

Returns the value for the environment variable PSModulePath.

EXAMPLE 2

Get-EnvironmentVariable -Name 'PSModulePath' -FromTarget 'Machine'

Returns the value for the environment variable PSModulePath from the Machine target.

PARAMETERS

-FromTarget

Specifies the target to return the value from. Defaults to 'Session'.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: Session
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the environment variable name.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.String

[System.String]

NOTES

RELATED LINKS