Emulating -ErrorAction in custom powershell function

Question

How to emulate -ErrorAction in custom powershell function. For example consider the following script

function Foo2
{
  Write-Host "in Foo2"
  #...Error occurs 
  Foo3
}

function Foo1
{
   Write-Host "in Foo1"
   Foo2
}

function Foo3
{
   Write-Host "in Foo3"
}

PS>Foo1 -ErrorAction stop

Is it possible to stop the execution of Foo1 when error occurs in Foo2, instead of proceeding with execution of Foo3 ?

This question is similar to: How to handle powershell Advanced function ErrorAction parameter?. If you believe it’s different, please edit the question, make it clear how it’s different and/or how the answers on that question are not helpful for your problem. — c z
– c z, Commented Aug 20, 2024 at 9:18

Matt · Accepted Answer · 2015-12-14 12:33:49Z

24

get-help about_Functions_CmdletBindingAttribute

You want:

function Foo1() {
 [CmdletBinding()]
 PARAM()
 process{
   Write-Host "in Foo1"
   Foo2
 }
}

This is not about emulation, it means really implementing common parameters in your function; if this was your intention.

After that, you can work like this:

Foo1 -ErrorAction stop

You can use the same syntax for Foo2 and Foo3.

To log error use redirection as usual.

edited Dec 14, 2015 at 12:33

Matt

47.1k9 gold badges90 silver badges125 bronze badges

answered May 10, 2011 at 14:21

Emiliano Poggi

24.9k8 gold badges58 silver badges66 bronze badges

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

3 Comments

Jeevan Over a year ago

let me make it clear, just like how standard cmdlet will stop or continue when error occurs based on value of ErrorAction , I want even Foo1 to behave exactly like that also i would like to log the error. How can i do that ?

Emiliano Poggi Over a year ago

If you use cmdletbinding you can do exactly that gratis! See my edit.

JasonMArcher Over a year ago

Small note, the Write-Error calls or errors from nested commands will use that, Write-Host will not. :)

JPBlanc · Accepted Answer · 2011-05-10 17:06:01Z

10

Here is a sample to illustrate @Empo Answer

function Test-ErrorAction
{
  [CmdletBinding()]
  Param( )

  begin 
  {
    Write-Host "I'am Here"    
   }

  Process 
  {
    Write-Error "coucou"
  }
  end 
  {
    Write-Host "Done !"
  }
}

clear
Test-ErrorAction -ErrorAction "silentlycontinue"
Test-ErrorAction -ErrorAction "stop"

gives

I'am Here
Done !
I'am Here
coucou
 à C:\Développements\Pgdvlp_Powershell\Sources partagées\Menus Contextuel Explorer\Test-ErrorAction.ps1: ligne:23 caractère:17
+ Test-ErrorAction  <<<< -ErrorAction "stop"

answered May 10, 2011 at 17:06

JPBlanc

73.1k18 gold badges137 silver badges180 bronze badges

2 Comments

JohnLBevan Over a year ago

NB: It's also worth noting that for ErrorAction to behave as you'd expect, you should raise errors with Write-Error. If you throw an exception, ErrorAction / ErrorActionPreference has no influence; the exception is a Stop (terminating error) by definition. stackoverflow.com/a/9295344/361842

Chris Over a year ago

Thank you, that probably just avoided a lot of frustration for me as that's exactly what I was doing...🤔

mjolinor · Accepted Answer · 2011-05-10 13:45:10Z

0

function Foo2
{
 Write-Host "in Foo2"
 Try {something} 
   Catch {
             Write-host "Foo2 blew up!"
             return
             }
 Foo3
 }

answered May 10, 2011 at 13:45

mjolinor

68.7k7 gold badges118 silver badges141 bronze badges

Collectives™ on Stack Overflow

Emulating -ErrorAction in custom powershell function

3 Answers 3

3 Comments

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related