InTestMode (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Functions for Windows management

Various WINDEV functions

InTestMode

Presentation

Example

See also

InTestMode (Function)

In french: EnModeTest

Warning
From version 16, OntestMode is kept for backward compatibility. This function is replaced by InTestMode.

Indicates whether the application or the site is started:

from the WINDEV or WEBDEV editor,
from the executable or browser.
from the WEBDEV administrator.

This function has no effect in this version.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 16 and later

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Windows Phone applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

Example

IF InTestMode() = True THEN
Trace("MenuNum variable: " + MenuNum)
END

Syntax

Checking the start mode of application Hide the details

<Result> = InTestMode()

<Result>: Boolean

True if the application is run:
from the WINDEV editor (window or project Go).
from the editor of Reports and Queries (report Go).
in debug on Mobile.
in component debug via executable.
from the WEBDEV editor (page or project Go).
from the WEBDEV administrator (Test button).
Versions 25 and later
in debug mode on an Android device (or if the application generated for debug mode is started on the Android device).
New in version 25
in debug mode on an Android device (or if the application generated for debug mode is started on the Android device).
in debug mode on an Android device (or if the application generated for debug mode is started on the Android device).
False otherwise.
Special cases:
In AWP mode, this parameter always corresponds to False.
Versions 22 and later
In a REST Webservice, this parameter always corresponds to False.
New in version 22
In a REST Webservice, this parameter always corresponds to False.
In a REST Webservice, this parameter always corresponds to False.
This parameter always corresponds to False.

Versions 16 and later

Checking the origin of start mode of application test Hide the details

<Result> = InTestMode([<Type of execution>])

<Result>: Boolean

True if the test is run from the requested element,
False otherwise.
Remark: The start mode taken into account is the one for the origin of test. For example, if the test of the report is run from a window displayed by a project GO, the origin of test will be the project GO.

<Type of execution>: Integer constant (or combination of constants)

Origin of test execution:
Versions 16 and later
tmReport
New in version 16
tmReport
tmReport Test run from a report Go.
Versions 16 and later
tmWindow
New in version 16
tmWindow
tmWindow Test run from a window Go.
Versions 16 and later
tmPage
New in version 16
tmPage
tmPage Test run from a page Go.
Versions 16 and later
tmProcedure
New in version 16
tmProcedure
tmProcedure Test run from a procedure Go.
Versions 16 and later
tmProject
New in version 16
tmProject
tmProject Test run from a project Go.
Versions 16 and later
tmQuery
New in version 16
tmQuery
tmQuery Test run from a query Go.
Versions 16 and later
tmTest
New in version 16
tmTest
tmTest Test run from the Go of an automatic test.

New in version 16

Checking the origin of start mode of application test Hide the details

<Result> = InTestMode([<Type of execution>])

<Result>: Boolean

True if the test is run from the requested element,
False otherwise.
Remark: The start mode taken into account is the one for the origin of test. For example, if the test of the report is run from a window displayed by a project GO, the origin of test will be the project GO.

<Type of execution>: Integer constant (or combination of constants)

Origin of test execution:
Versions 16 and later
tmReport
New in version 16
tmReport
tmReport Test run from a report Go.
Versions 16 and later
tmWindow
New in version 16
tmWindow
tmWindow Test run from a window Go.
Versions 16 and later
tmPage
New in version 16
tmPage
tmPage Test run from a page Go.
Versions 16 and later
tmProcedure
New in version 16
tmProcedure
tmProcedure Test run from a procedure Go.
Versions 16 and later
tmProject
New in version 16
tmProject
tmProject Test run from a project Go.
Versions 16 and later
tmQuery
New in version 16
tmQuery
tmQuery Test run from a query Go.
Versions 16 and later
tmTest
New in version 16
tmTest
tmTest Test run from the Go of an automatic test.

Checking the origin of start mode of application test Hide the details

<Result> = InTestMode([<Type of execution>])

<Result>: Boolean

True if the test is run from the requested element,
False otherwise.
Remark: The start mode taken into account is the one for the origin of test. For example, if the test of the report is run from a window displayed by a project GO, the origin of test will be the project GO.

<Type of execution>: Integer constant (or combination of constants)

Origin of test execution:
Versions 16 and later
tmReport
New in version 16
tmReport
tmReport Test run from a report Go.
Versions 16 and later
tmWindow
New in version 16
tmWindow
tmWindow Test run from a window Go.
Versions 16 and later
tmPage
New in version 16
tmPage
tmPage Test run from a page Go.
Versions 16 and later
tmProcedure
New in version 16
tmProcedure
tmProcedure Test run from a procedure Go.
Versions 16 and later
tmProject
New in version 16
tmProject
tmProject Test run from a project Go.
Versions 16 and later
tmQuery
New in version 16
tmQuery
tmQuery Test run from a query Go.
Versions 16 and later
tmTest
New in version 16
tmTest
tmTest Test run from the Go of an automatic test.

Remarks

Other possibilities

InSimulatorMode is used to differentiate between the test mode on the mobile device and on the simulator.
InReportsAndQueriesMode is used to differentiate between the test mode from the report editor and the test mode from Reports & Queries.

GO from Reports & Queries

InTestMode and InReportsAndQueriesMode return True when the test of a report is run from "Reports and Queries" ("GO" button).

We advise you to replace the standard test:

IF InTestMode() = True THEN
Trace("...")
END

by the following test:

IF InTestMode() = True AND InReportsAndQueriesMode() = False THEN
Trace("...")
END

Availability of the function

InTestMode is available for all the products to allow for a multi-product code. Functions or procedures that use InTestMode can be shared between several products without generating any compilation error.

Business / UI classification : Neutral code

Component : wd260vm.dll