Skip to content

Latest commit

 

History

History
158 lines (120 loc) · 4.13 KB

Get-EnvironmentVariable.md

File metadata and controls

158 lines (120 loc) · 4.13 KB
Raw
external help file Module Name online version schema
PSPreworkout-help.xml
PSPreworkout
2.0.0

Get-EnvironmentVariable

SYNOPSIS

Retrieves the value of an environment variable.

SYNTAX

Get-EnvironmentVariable [[-Name] <String>] [-Pattern <String>] [-Target <EnvironmentVariableTarget[]>] [-All]
 [<CommonParameters>]

DESCRIPTION

The Get-EnvironmentVariable function retrieves the value of the specified environment variable or displays all environment variables.

EXAMPLES

EXAMPLE 1

Get-EnvironmentVariable -Name 'UserName'
Retrieves the value of the "UserName" environment variable from the process target.

EXAMPLE 2

Get-EnvironmentVariable -Name 'Path' -Target 'Machine'
Retrieves the value of the PATH environment variable from the machine target.

EXAMPLE 3

Get-EnvironmentVariable -Pattern '^u'
Get environment variables with names that begin with the letter "u" in any target.

EXAMPLE 4

Get-EnvironmentVariable -Pattern 'git' | Format-Table Name,Target,PID,ProcessName,Value

Get all process environment variables that match the pattern "git" and return the results as a table.

EXAMPLE 5

Get-EnvironmentVariable -Pattern 'path' -Target Machine,Process,User | Format-Table Name,Target,PID,ProcessName,Value

Return all environment variables that match the pattern "path" from all targets and format the results as a table.

PARAMETERS

-Name

The name of the environment variable to retrieve.

Type: String
Parameter Sets: (All)
Aliases:

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

-Pattern

A regex pattern to match environment variable names against.

Type: String
Parameter Sets: (All)
Aliases:

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

-Target

The target (Process, Machine, User) to pull environment variables from. The default is process. Multiple targets may be specified.

Type: EnvironmentVariableTarget[]
Parameter Sets: (All)
Aliases:
Accepted values: Process, User, Machine

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

-All

Optionally get all environment variables from all targets. Process ID and process name will be included for process environment variables.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

PSObject

NOTES

Author: Sam Erde Version: 0.1.0 Modified: 2024/10/8

To Do: Return environment variables if -Target is used without either -Name or -Pattern.

About Environment Variables:

Variable names are case-sensitive on Linux and macOS, but not on Windows.

Why is 'Target' used by .NET instead of the familiar 'Scope' parameter name? @IISResetMe (Mathias R. Jessen) explains: "Scope" would imply some sort of integrated hierarchy of env variables - that's not really the case. Target=Process translates to kernel32!GetEnvironmentVariable (which then in turn reads the PEB from the calling process), whereas Target={User,Machine} causes a registry lookup against environment data in either HKCU or HKLM.

The relevant sources for the User and Machine targets are in the registry at:

  • HKEY_CURRENT_USER\Environment
  • HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment

See more at <https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_environment_variables\>.

RELATED LINKS