{"id":55,"date":"2007-01-23T04:00:00","date_gmt":"2007-01-23T12:00:00","guid":{"rendered":"http:\/\/testblog.sapien.com\/index.php\/2007\/01\/23\/using-errorvariable\/"},"modified":"2007-01-23T04:00:00","modified_gmt":"2007-01-23T12:00:00","slug":"using-errorvariable","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2007\/01\/23\/using-errorvariable\/","title":{"rendered":"Using ErrorVariable"},"content":{"rendered":"

Another common parameter you might want to include in your PowerShell code is -ErrorVariable. Like -OutVariable that I talked about yesterday<\/a>, you can redirect error information to a specified variable:<\/p>\n<\/p>\n

\n
gwmi win32_operatingsystem <\/span>-<\/span>errorvariable oops <\/span>|<\/span>out<\/span>-<\/span>null<\/span><\/div><\/pre>\n<\/div>\n
In this situation, $oops will have no value since no error was returned. But what about this where $computer is a remote computer that you’ve mistyped, don’t have permission for or is down:<\/p>\n<\/p>\n
\n
gwmi win32_operatingsystem <\/span>-<\/span>computer $computer <\/span>-<\/span>errorvariable oops <\/span>|<\/span>out<\/span>-<\/span>null<\/span><\/div><\/pre>\n<\/div>\n
Now if you look at $oops you’ll see the error message. Any errors are still recorded in the default $error variable. $oops is an error record as you can see:<\/p>\n
\n
Mon <\/span>1<\/span>\/<\/span>22<\/span>\/<\/span>2007<\/span> <\/span>12<\/span>:<\/span>25<\/span>:<\/span>15<\/span> PM PS S:\\ <\/span>><\/span> $oops <\/span>|<\/span>gm


   TypeName: System.Management.Automation.ErrorRecord

Name                      MemberType Definition
<\/span>----<\/span>                      <\/span>----------<\/span> <\/span>----------<\/span>Equals                    Method     System.Boolean Equals(Object obj)GetHashCode               Method     System.Int32 GetHashCode()GetObjectData             Method     System.Void GetObjectData(Serialization..GetType                   Method     System.Type GetType()get_CategoryInfo          Method     System.Management.Automation.ErrorCateg..get_ErrorDetails          Method     System.Management.Automation.ErrorDetai..get_Exception             Method     System.Exception get_Exception()get_FullyQualifiedErrorId Method     System.String get_FullyQualifiedErrorId()get_InvocationInfo        Method     System.Management.Automation.Invocation..get_TargetObject          Method     System.Object get_TargetObject()set_ErrorDetails          Method     System.Void set_ErrorDetails(ErrorDetai..ToString                  Method     System.String ToString()CategoryInfo              Property   System.Management.Automation.ErrorCateg..ErrorDetails              Property   System.Management.Automation.ErrorDetai..Exception                 Property   System.Exception Exception {<\/span>get<\/span>;}
FullyQualifiedErrorId     Property   System.String FullyQualifiedErrorId {<\/span>get<\/span>;
InvocationInfo            Property   System.Management.Automation.Invocation..
TargetObject              Property   System.Object TargetObject {<\/span>get<\/span>;}
<\/span><\/div><\/pre>\n<\/div>\n
It’s not apparent, but this is an array that should only have a single member. So if you wanted to see the exception you would use code like this:<\/p>\n<\/p>\n
\n
$oops[<\/span>0<\/span>].Exception<\/span><\/div><\/pre>\n<\/div>\n
If you were adding error handling to handle different error codes you’ll want to use something like this:<\/p>\n
\n
 ($oops[<\/span>0<\/span>].Exception).errorcode<\/span><\/div><\/pre>\n<\/div>\n
For the RPC server unavailable error you would see -2147023174<\/p>\n
Defining your own error variables gives you some additional flexibility for your PowerShell scripts and expressions.<\/p>\n
Technorati tags: PowerShell<\/a>, Variables<\/a>, Error<\/a>, Scripting<\/a><\/div>\n","protected":false},"excerpt":{"rendered":"
Another common parameter you might want to include in your PowerShell code is -ErrorVariable. Like -OutVariable that I talked about yesterday, you can redirect error information to a specified variable:gwmi win32_operatingsystem -errorvariable oops |out-null<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[2,25],"tags":[],"class_list":["post-55","post","type-post","status-publish","format-standard","hentry","category-general","category-windows-powershell"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/55","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=55"}],"version-history":[{"count":0,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/55\/revisions"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=55"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=55"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=55"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}