Get-KFQuickfixState

Syntax

Get-KFQuickfixState [-QuickfixId] <integer> [-Detailed[:$false]] [-ThrowErrors[:$true]]

Support

>= kenaflow 4.0.32

Return

Boolean. (without -Detailed)

or

An object with 3 properties State SystemState InstanceState

Description

This cmdlet is used to retrieve the current activation status of the specified quickfix (-QuickfixId <integer>).

Without -Detailed it just returns $true if the quickfix is active or $false if it is inactive.

With -Detailed it returns an object with three properties:

  • State => Is the quickfix active ($true) or not ($false) SystemState => Integer value of the setting for all kenaflow instances of the current server InstanceState => integer value of the setting for the current kenaflow instance

Please read article Quickfix for details!

Parameters

-Detailed

This can be used to create a single boolean status value or a more complex information about the activation status of the specified quickfix (-QuickfixId <integer>).

[-ThrowErrors[:$true]]

This is a default parameter for all kenaflow cmdlets. If set to $true (default!) the engine will pass exception within the cmdlet to the script for further handling.

Examples

Get-KFQuickfixState 3 -Detailed