This is the built-in help made by Microsoft for the command 'New-Variable', in PowerShell version 5 - as retrieved from
Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Creates a new variable.
New-Variable [-Name] <String> [[-Value] [<Object>]] [-Description [<String>]] [-Force] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable [<System.String>]] [-Option {None | ReadOnly | Constant | Private | AllScope | Unspecified}] [-PassThru] [-Scope [<String>]] [-Visibility {Public |
Private}] [-Confirm] [-WhatIf] [<CommonParameters>]
The New-Variable cmdlet creates a new variable in Windows PowerShell. You can assign a value to the variable while creating it or assign or change the value after it is
created.
You can use the parameters of New-Variable to set the properties of the variable (such as those that create read-only or constant variables), set the scope of a variable,
and determine whether variables are public or private.
Typically, you create a new variable by typing the variable name and its value, such as "$var = 3", but you can use the New-Variable cmdlet to use its parameters.
<
Online Version: http://go.microsoft.com/fwlink/p/?linkid=293995
Clear-Variable
Get-Variable
Remove-Variable
Set-Variable
<
-------------------------- EXAMPLE 1 --------------------------
PS C:\>new-variable days
This command creates a new variable named "days". It has no value immediately following the command.
-------------------------- EXAMPLE 2 --------------------------
PS C:\>new-variable zipcode -value 98033
This command creates a variable named "zipcode" and assigns it the value "98033".
-------------------------- EXAMPLE 3 --------------------------
PS C:\>new-variable -name max -value 256 -option readonly
PS C:\>new-variable -name max -value 1024
New-Variable : A variable with name 'max' already exists.
At line:1 char:13
+ new-variable <<<< -name max -value 1024
PS C:\>new-variable -name max -value 1024 -force
This example shows how to use the ReadOnly option of New-Variable to protect a variable from being overwritten.
The first command creates a new variable named Max and sets its value to "256". It uses the Option parameter with a value of ReadOnly.
The second command tries to create a second variable with the same name. This command returns an error, because the read-only option is set on the variable.
The third command uses the Force parameter to override the read-only protection on the variable. In this case, the command to create a new variable with the same name
succeeds.
-------------------------- EXAMPLE 4 --------------------------
PS C:\>new-variable -name counter -visibility private
#Effect of private variable in a module.
PS C:\>get-variable c*
Name Value
---- -----
Culture en-US
ConsoleFileName
ConfirmPreference High
CommandLineParameters {}
PS C:\>$counter
"Cannot access the variable '$counter' because it is a private variable"
PS C:\>Get-Counter
Name Value
---- -----
Counter1 3.1415
...
This command demonstrates the behavior of a private variable in a module. The module contains the Get-Counter cmdlet, which has a private variable named "Counter". The
command uses the Visibility parameter with a value of "Private" to create the variable.
The sample output shows the behavior of a private variable. The user who has loaded the module cannot view or change the value of the Counter variable, but the Counter
variable can be read and changed by the commands in the module.