Increment a variable in PowerShell in functions

Question

How do I increment a variable in a PowerShell function?

I'm using the below example without any data to be input to the function. I want to increment a variable every time a function is called. The variable $incre has 1 added to it and then displays the total of $incre when the script completes.

The total when running the below is 0, whereas the result I want is 4 as the function comparethis has been run 4 times and each time $incre has been incremented by 1.

 $incre = 0

 function comparethis() {
     # Do this comparison

    $incre++
    Write-Host $incre
 }

 comparethis #compare 2 variables
 comparethis #compare 2 variables
 comparethis #compare 2 variables
 comparethis #compare 2 variables

 Write-Host "This is the total $incre"

StephenP · Accepted Answer · 2014-07-09 04:07:47Z

47

You are running into a dynamic scoping issue. See about_scopes. Inside the function $incre is not defined so it is copied from the global scope. The global $incre is not modified. If you wish to modify it you can do the following.

$incre = 0

function comparethis() {
    #Do this comparison

    $global:incre++
    Write-Host $global:incre
}

comparethis #compare 2 variables
comparethis #compare 2 variables
comparethis #compare 2 variables
comparethis #compare 2 variables

Write-Host "This is the total $incre"

answered Jul 9, 2014 at 4:07

StephenP

4,15122 silver badges19 bronze badges

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

1 Comment

gerard Over a year ago

In the example above it is probably more likely that you want to treat the $incre variable as a script-level variable, rather than a global variable. In that case, you should use $Script:incre rather than $Global:incre

mialkin · Accepted Answer · 2021-03-27 19:19:05Z

7

If you want your counter to reset each time you execute the same script use $script scope:

$counter = 1;

function Next() {
    Write-Host $script:counter

    $script:counter++
}

Next # 1
Next # 2
Next # 3

With $global scope you will get 4 5 6 on the second script run, not 1 2 3.

edited Mar 27, 2021 at 19:19

answered Mar 27, 2021 at 18:24

mialkin

2,9612 gold badges37 silver badges32 bronze badges

Comments

Tyron78 · Accepted Answer · 2020-07-01 09:14:47Z

2

Rather than using a global variable I woul suggest to call the function with a reference to the variable:

[int]$incre = 0

function comparethis([ref]$incre) {
    $incre.value++;
}

comparethis([ref]$incre) #compare 2 variables
Write-Host $incre
comparethis([ref]$incre) #compare 2 variables
Write-Host $incre

answered Jul 1, 2020 at 9:14

Tyron78

4,1973 gold badges21 silver badges32 bronze badges

Collectives™ on Stack Overflow

Increment a variable in PowerShell in functions

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related