powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-StrictMode



NAME
Set-StrictMode

SYNOPSIS
Establishes and enforces coding rules in expressions, scripts, and script blocks.

SYNTAX
Set-StrictMode -Off []

Set-StrictMode -Version []


DESCRIPTION
The Set-StrictMode cmdlet configures strict mode for the current scope (and all child scopes) and turns it on and o
ff. When strict mode is on, Windows PowerShell generates a terminating error when the content of an expression, scr
ipt, or script block violates basic best-practice coding rules.

Use the Version parameter to determine which coding rules are enforced.

Unlike the Set-PSDebug cmdlet, Set-StrictMode affects only the current scope and its child scopes, so you can use i
t in a script or function without affecting the global scope.

When Set-StrictMode is off, uninitialized variables (Version 1) are assumed to have a value of 0 (zero) or $null, d
epending on type. References to non-existent properties return $null, and the results of function syntax that is no
t valid vary with the error. Unnamed variables are not permitted.


PARAMETERS
-Off []
Turns strict mode off. This parameter also turns off "Set-PSDebug -Strict".

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

-Version
Specifies the conditions that cause an error in strict mode. This parameter is required.

The valid values are "1.0", "2.0", and "Latest". The following list shows the effect of each value.

1.0
-- Prohibits references to uninitialized variables, except for uninitialized variables in strings.

2.0
-- Prohibits references to uninitialized variables (including uninitialized variables in strings).
-- Prohibits references to non-existent properties of an object.
-- Prohibits function calls that use the syntax for calling methods.
-- Prohibits a variable without a name (${}).

Latest:
--Selects the latest (most strict) version available. Use this value to assure that scripts use the strictest
available version, even when new versions are added to Windows PowerShell.

Required? true
Position? named
Default value None
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
None
You cannot pipe input to this cmdlet.


OUTPUTS
None
This cmdlet does not return any output.


NOTES


Set-StrictMode is similar to the Strict parameter of Set-PSDebug. "Set-Strictmode -version 1" is equivalent to
"Set-PSDebug -strict", except that Set-PSDebug is effective in all scopes. Set-StrictMode is effective only in
the scope in which it is set and in its child scopes. For more information about scopes in Windows PowerShell,
see about_Scopes.


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

C:\PS>set-strictmode -version 1.0

C:\PS> $a -gt 5
False
The variable $a cannot be retrieved because it has not been set yet.
At line:1 char:3
+ $a <<<< -gt 5
+ CategoryInfo : InvalidOperation: (a:Token) [], RuntimeException
+ FullyQualifiedErrorId : VariableIsUndefined


Description
-----------
This command turns strict mode on and sets it to version 1.0. As a result, attempts to reference variables that are
not initialized will fail.

The sample output shows the effect of version 1.0 strict mode.





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

C:\PS># set-strictmode -version 2.0

# Strict mode is off by default.

C:\PS> function add ($a, $b) {$a + $b}
C:\PS> add 3 4
7
C:\PS> add(3,4)
3
4

C:\PS> set-strictmode -version 2.0

C:\PS> add(3,4)

The function or command was called like a method. Parameters should be separated by spaces, as described in 'Get-He
lp about_Parameter.'
At line:1 char:4
+ add <<<< (3,4)
+ CategoryInfo : InvalidOperation: (:) [], RuntimeException
+ FullyQualifiedErrorId : StrictModeFunctionCallWithParens


C:\PS> set-strictmode -off

C:\PS> $string = "This is a string".
C:\PS> $string.Month
C:\PS>

C:\PS> set-strictmode -version 2.0

C:\PS> $string = "This is a string".
C:\PS> $string.Month
Property 'month' cannot be found on this object; make sure it exists.
At line:1 char:9
+ $string. <<<< month
+ CategoryInfo : InvalidOperation: (.:OperatorToken) [], RuntimeException
+ FullyQualifiedErrorId : PropertyNotFoundStrict


Description
-----------
This command turns strict mode on and sets it to version 2.0. As a result, Windows PowerShell throws an error if yo
u use method syntax (parentheses and commas) for a function call or reference uninitialized variables or non-existe
nt properties.

The sample output shows the effect of version 2.0 strict mode.

Without version 2.0 strict mode, the "(3,4)" value is interpreted as a single array object to which nothing is adde
d. With version 2.0 strict mode, it is correctly interpreted as faulty syntax for submitting two values.

Without version 2.0, the reference to the non-existent Month property of a string returns only null. With version 2
.0, it is interpreted correctly as a reference error.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113450
about_Debuggers
about_Scopes
Set-PSDebug