How to return custom Errorlevel in PowerShell?

Question

I want to run the script from command line, and get the error level. I use this batch script.

set log=C:\Users\PowerShell\XML\Log.txt
set PS=C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe
set PS=%PS%\powershell.exe 

"C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe" C:\Users\XML.ps1 -i C:\Users\A2.txt -j C:\Users\Fb.xml
   
echo %ERRORLEVEL% > "%log%"

I tried this script to get the custom errorlevel, If it is found, it will return 123, otherwise 456. But It always gives me 1.

$regex = [regex]$Pattern

$matching = $regex.Match($FBString)
if ($matching.Success) {
    while ($matching.Success) {
        "Match found: {0}" -f $matching.Value
        Exit 123
        $matching = $matching.NextMatch()
    }
}
else {
    "Not Found"
    Exit 456
}

Ranadip Dutta · Accepted Answer · 2019-03-12 06:26:21Z

2

Change the Exit to Return . Exit will exit your script. Return will return values that you wish for.

answered Mar 12, 2019 at 6:26

Ranadip Dutta

9,5593 gold badges33 silver badges48 bronze badges

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

5 Comments

Job Over a year ago

It works when I run it from powershell. But I want to get the errorlevel value by using batch file

Ranadip Dutta Over a year ago

0 indicates that script ran successfully and 1 indicates that there is an error. If you want to capture the same in batch then you have redirect them to stdout

ZEE Over a year ago

( exit <n> ) set the system %errorlevel% environment variable... while ( return <n> ) will try to pass the object <n> to the calling code... or by default write it to out-default... so is you want to use batch files or other executables to call your powershell code and interact with the result in the OS standard way... you should use exit <n> ;-)

Cadoiz Over a year ago

Unfortunately, I have to disagree, as your answer is not true (at least not any longer). Using exit \b 123 is best practice for exit-codes since windows 2000/xp (pretty much at the button of this link).

mklement0 Over a year ago

The question is about the process exit code set by powershell.exe (which cmd.exe reflects in %ERRORLEVEL%), which you can only set with exit. By contrast, passing an argument to return outputs the latter as data (to stdout, from an external caller's perspective).

Cadoiz · Accepted Answer · 2021-09-15 02:52:35Z

2

You can write the logic in your script
so any exit point will set the %errorlevel% system variable...

and create your "error return logic"...

something lihe this:

if ( $LASTEXITCODE -eq 0 ) { exit 0  }
if ( $LASTEXITCODE -eq 1 ) { exit 1  }
if ( $x -gt 1 ) { exit 2  }
if ( $x -lt 1 ) { exit 3  }
...

and then you can inspect from a batch file for %errorlevel% == 0, 1, 2, ...

edited Sep 15, 2021 at 2:52

Cadoiz

1,7042 gold badges25 silver badges36 bronze badges

answered Aug 9, 2019 at 11:40

ZEE

3,2535 gold badges38 silver badges52 bronze badges

Comments

js2010 · Accepted Answer · 2019-08-09 11:55:53Z

1

Run the script with powershell -file. The default is powershell -command. Once that script is over, with -command the session is still going.

answered Aug 9, 2019 at 11:55

js2010

28.4k6 gold badges82 silver badges88 bronze badges

2 Comments

Binarus Over a year ago

Thank you very much! This saved my day ... and should be the accepted answer (no rewriting of scripts, the desired exit code directly put into %errorlevel%).

mklement0 Over a year ago

Good point re -File vs. -Command, but what do you mean by "the session is still going"?

mklement0 · Accepted Answer · 2024-06-20 14:23:55Z

1

The problem is in the batch file. It should be like this :

set log=C:\Users\PowerShell\XML\Log.txt    

# Note the use of -File
"C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe" -ExecutionPolicy Bypass -File C:\Users\XML.ps1 -i C:\Users\A2.txt -j C:\Users\Fb.xml

echo %ERRORLEVEL% > "%log%"

For the first PowerShell script is correct already.

edited Jun 20, 2024 at 14:23

mklement0

453k68 gold badges729 silver badges989 bronze badges

answered Mar 12, 2019 at 8:33

Job

5053 gold badges17 silver badges36 bronze badges

1 Comment

mklement0 Over a year ago

Indeed, but to spell it out: To make the PowerShell CLI (powershell.exe for Windows PowerShell, pwsh for PowerShell (Core) 7) report the exit code of a script file (*.ps1) as the CLI's process exit code, use the -File parameter (implied with pwsh). If you use -Command (implied with powershell.exe), the exit code gets mapped onto 0 or 1, based on the abstract success status of the script (of the last command executed). For a comprehensive overview of PowerShell's exit-code handling, see this answer

Collectives™ on Stack Overflow

How to return custom Errorlevel in PowerShell?

4 Answers 4

5 Comments

Comments

2 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

5 Comments

Comments

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related