# Get-BluGenieErrorAction



### Get-BluGenieErrorAction <a href="#get-blugenieerroraction" id="get-blugenieerroraction"></a>

### SYNOPSIS <a href="#synopsis" id="synopsis"></a>

Get-BluGenieErrorAction is a function that will round up any errors into a smiple object

### SYNTAX <a href="#syntax" id="syntax"></a>

```
Get-BluGenieErrorAction [-Clear] [-List] [-Walkthrough] [-ReturnObject] [-OutUnEscapedJSON] [<CommonParameters>]
```

### DESCRIPTION <a href="#description" id="description"></a>

Get-BluGenieErrorAction is a function that will round up any errors into a smiple object

### EXAMPLES <a href="#examples" id="examples"></a>

#### EXAMPLE 1 <a href="#example-1" id="example-1"></a>

```
Command: Get-BluGenieErrorAction
```

```
Description: Display error information in a readable format
Notes: This includes 
    * Action			= The actioning item or cmdlet
 * StackTracke	= From what Function, ScriptBlock, or CmdLet the error came from and the Line number
 * Line			= The command used when the error was generated
 * Error			= A string with a readable error message
```

#### EXAMPLE 2 <a href="#example-2" id="example-2"></a>

```
Command: Get-BluGenieErrorAction -Clear
```

```
Description: Clear all errors after processing each error message
Notes:
```

#### EXAMPLE 3 <a href="#example-3" id="example-3"></a>

```
Command: Get-BluGenieErrorAction -List
```

```
Description: Return information in a List format
Notes: By default the information is displayed in a Table format
```

#### EXAMPLE 4 <a href="#example-4" id="example-4"></a>

```
Command: Get-BluGenieErrorAction -Help
```

```
Description: Call Help Information
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal Get-Help will be called with the -Full parameter
```

#### EXAMPLE 5 <a href="#example-5" id="example-5"></a>

```
Command: Get-BluGenieErrorAction -WalkThrough
```

```
Description: Call Help Information [2]
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal Get-Help will be called with the -Full parameter
```

#### EXAMPLE 6 <a href="#example-6" id="example-6"></a>

```
Command: Get-BluGenieErrorAction -OutUnEscapedJSON
```

```
Description: Get-BluGenieErrorAction and Return Output as UnEscaped JSON format
Notes:  The OutUnEscapedJSON is used to beatify the JSON return and not Escape any Characters.  Normal return data is an Object.
```

#### EXAMPLE 7 <a href="#example-7" id="example-7"></a>

```
Command: Get-BluGenieErrorAction -ReturnObject
```

```
Description: Get-BluGenieErrorAction and Return Output an Object
Notes:  The ReturnObject is used to return a PowerShell Object.  This is the default.
```

### PARAMETERS <a href="#parameters" id="parameters"></a>

#### Clear <a href="#clear" id="clear"></a>

```
-Clear [<SwitchParameter>]
   Description: Clear all errors after trapping 
   Notes:  
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
```

#### List <a href="#list" id="list"></a>

```
-List [<SwitchParameter>]
   Description: Return data is in a List format
   Notes: By default the return data is in a Table format
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
```

#### Walkthrough <a href="#walkthrough" id="walkthrough"></a>

```
-Walkthrough [<SwitchParameter>]
   Description:  Start the dynamic help menu system to help walk through the current command and all of the parameters
   Notes:  
   Alias: Help
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
```

#### ReturnObject <a href="#returnobject" id="returnobject"></a>

```
-ReturnObject [<SwitchParameter>]
   Description: Return information as an Object
   Notes: By default the data is returned as a Hash Table
   Alias: 
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                True
   Accept pipeline input?       false
   Accept wildcard characters?  false
```

#### OutUnEscapedJSON <a href="#outunescapedjson" id="outunescapedjson"></a>

```
-OutUnEscapedJSON [<SwitchParameter>]
   Description: Remove UnEsacped Char from the JSON information.
   Notes: This will beautify json and clean up the formatting.
   Alias: 
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
```

#### CommonParameters <a href="#commonparameters" id="commonparameters"></a>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).