How to distinguish between empty argument and zero-value argument in Powershell?

Question

I want to be able to pass a single int through to a powershell script, and be able to tell when no variable is passed. My understanding was that the following should identify whether an argument is null or not:

if (!$args[0]) { Write-Host "Null" }
else { Write-Host "Not null" }

This works fine until I try to pass 0 as an int. If I use 0 as an argument, Powershell treats it as null. Whats the correct way to be able to distinguish between the argument being empty or having a zero value?

JPBlanc · Accepted Answer · 2024-10-07 04:24:39Z

15

You can just test $args variable or $args.count to see how many vars are passed to the script.

Another thing : $args[0] -eq $null is different from $args[0] -eq 0 and from !$args[0].

$args[0] -eq $null : This checks if the first argument in the $args array is equal to $null. If $args[0] is $null, it returns True; otherwise, it returns False.
$null -eq $args[0] : While this performs the same logical comparison, it is generally safer to use this order. Because if $args[0] is undefined or doesn't exist it prevents PowerShell from trying to evaluate a potentially non-existent value, reducing the risk of exception.
$args[0] -eq 0 : This checks if $args[0] is numerically equal to 0. PowerShell treats numbers differently from $null, so this comparison only returns True if $args[0] contains the number 0. If $args[0] is $null, or is $args[0] is a string, this will return False.
!$args[0] : checks for any "falsy" value, including $false, $null, 0, and an empty string.

edited Oct 7, 2024 at 4:24

answered Sep 4, 2013 at 7:35

JPBlanc

73k17 gold badges137 silver badges180 bronze badges

Sign up to request clarification or add additional context in comments.

8 Comments

Ryan Gillies Over a year ago

Didn't realise there was a difference between $args[0] -eq $null and !$args[0] - many thanks!

Michael Over a year ago

If you use the $Var directly in a condition it evaluates everything that is $Null or 0 to $False.. everything else to $True. So If(-1) is always False.

Rynant Over a year ago

@MichaelKargl What do you mean by "if(-1) is always false"? -1 evaluates to True (try [bool]-1). Also note that in addition to $null and 0, empty strings also evaluate to False ([bool]"")

Michael Over a year ago

My bad.. typo.. its always $True as it is unequal 0.

P.Brian.Mackey Over a year ago

This answer would be a lot better if it explained the differences between the equality checks. As it is I hear they are different, but I have no idea why. It should tell me how to properly check for empty/null/zero arguments.

|

Timo · Accepted Answer · 2021-02-23 15:09:52Z

5

If users like me come from Google and want to know how to treat empty command line parameters, here is a possible solution:

if (!$args) { Write-Host "Null" }

This checks the $args array. If you want to check the first element of the array (i.e. the first cmdline parameter), use the solution from the OP:

if (!$args[0]) { Write-Host "Null" }

answered Feb 23, 2021 at 15:09

Timo

3,2533 gold badges36 silver badges34 bronze badges

Comments

Paul Roub · Accepted Answer · 2019-04-17 15:44:48Z

3

If the variable is declared in param() as an integer then its value will be '0' even if no value is specified for the argument. To prevent that you have to declare it as nullable:

param([AllowNull()][System.Nullable[int]]$Variable)

This will allow you to validate with If ($Variable -eq $null) {}

edited Apr 17, 2019 at 15:44

Paul Roub

36.5k27 gold badges88 silver badges95 bronze badges

answered Apr 17, 2019 at 15:32

TheDude

311 bronze badge

Collectives™ on Stack Overflow

How to distinguish between empty argument and zero-value argument in Powershell?

3 Answers 3

8 Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

8 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related