Flags Property (AApp)

Version 8 (updated), 9-154 (Updated

Returns or sets (v9-154) flags representing all the conditions that have occurred since the application UUT started.

Syntax

 [ lFlags = ] Object.Flags ( lUutIndex )

The Flags property syntax has the following parts:

 

Name

Type

Description

Object

AProgram

AProgram object

lUutIndex (v8.0)

[Val] Long = -1

Optional. Specifies the UUT index. If not specified or  -1 returns the current UUT flags.

lFlags

enumARuntimeFlags

An integer specifying the conditions that have occurred since the application started.

Where

enumARuntimeFlags can be one of the following:

 

Name

Value

Description

aFlagsTaskSkipped

0x00000001

Task Skipped

aFlagsTestSkipped

0x00000002

Test Skipped

aFlagsLoopOnTaskCalled

0x00000004

Loop On Test Called

aFlagsLoopOnTestCalled

0x00000008

Loop On Task Called

aFlagsCurrentTaskCalled

0x00000010

Current Task Called

aFlagsCurrentTestCalled

0x00000020

Current Test Called

aFlagsStepTraceCalled

0x00000040

Step/Trace Called

aFlagsDoitLoopitCalled

0x00000080

Doit/Loopit

aFlagsPauseCalled

0x00000100

Pause Called

aFlagsAbortCalled

0x00000200

Abort Called

aFlagsErrorCalled

0x00000400

Error Called

aFlagsIgnoreCalled

0x00000800

Ignore Called

aFlagsRetryCalled

0x00001000

Retry Called

aFlagsResetCalled

0x00002000

Reset Called

aFlagsValueChanged

0x00004000

Change Value

aFlagsSetNextStatementCalled

0x00008000

Set Next Statement

aFlagsExitProgram

0x00010000

ExitProgram Called

aFlagsExitTask

0x00020000

ExitTask Called

aFlagsTaskByTask

0x00040000

Task By Task

aFlagsTestByTest

0x00080000

Test By Test

aFlagsPauseOnFail

0x00100000

Pause On Fail

aFlagsProgramit

0x00200000

ProgramIt ! mode

aFlagsTaskit

0x00400000

TaskIt! mode

aFlagsTestit

0x00800000

TestIt! mode

aFlagsLoopOnTask

0x01000000

Loop On Task

aFlagsLoopOnTest

0x02000000

Loop On Test

aFlagsCurrentTask

0x04000000

Current Task

aFlagsCurrentTest

0x08000000

Current Test

aFlagsJumpProgramTaskTest

0x10000000

Step/Trace

aFlagsDoitLoopit

0x20000000

Doit/Loopit

aFlagsFormit

0x40000000

Formit! mode

aFlagsExit

0x80000000

Exit Called

Comments

This property returns a combination of all the flags which have been set so far by ATEasy or by the application.

The aFlagsProgramit, aFlagsTaskit, aFlagsTestit and aFlagsFormit flags can be used to determine if this is a full run or a partial run from the ATEasy development environment. Other flags such as aFlagsSetNextStatementCalled or aFlagsValueChanged can let the program know if debugging changes where done during the life of the run. You can use the DebugLog Variable to determine also if the application is running from the IDE.

The ATEasy test executive driver uses these flags to determine if we are debugging from the development environment and it that case it disabled itself as being a test executive and let the ATEasy development environment act as a Test Executive.

v9-154. The property can also be set by the application. You can only set the lower 16 bits (1-0x8000, aFlagsTaskSkipped to aFlagsSetNextStatementCalled ).

Example

The following statement set the driver variable to be disabled if we run using ProgramIt! from the ATEasy development environment:

if app.Flags and aFlagsProgramIt then print Driver.m_bDisable=True

The following statement clears two flags from the Flags property:

App.Flags(-1)=App.Flags and not (aFlagsStepTraceCalled or aFlagsPauseCalled )

Applies to

AApp

See Also

AProgram.Flags, DebugLog