APIParameter (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

APIParameter (Function)

In french: APIParamètre

Modifies the options for calling API and CallDLL32.

Note: Modified behavior of API and CallDLL32 functions:

Behavior up to version 100045:

API and CallDLL32 lock the other threads.
If the API function called modifies the system regional settings (languages, decimal places, ...), the previous regional settings are not restored.

Behavior from version 100050:

API and CallDLL32 do not lock the other threads anymore.
If the API function called modifies the system regional settings, the previous regional settings are restored.

APIParameter is used to configure the default behavior of these functions.

By default:

API and CallDLL32 do not lock the other threads.
If the API function called modifies the system regional settings, the previous regional settings are restored.

APIParameter is used to configure the default behavior of these functions.

Example

// Lock the threads
APIParameter(apiLockThreads, True)

// Don't restore the regional settings
APIParameter(apiRestoreSystemSettings, False)

Syntax

Finding out the value of an option for API and CallDLL32 Hide the details

<Result> = APIParameter(<Option>)

<Result>: Boolean

Value of the requested option:
True if the requested option is enabled,
False otherwise.

<Option>: Integer constant

Parameter whose value is requested:
apiLockThreads Used to find out whether API or CallDLL32 locks the threads during its execution.
This option is disabled by default.
apiRestoreSystemSettings Used to find out whether API or CallDLL32 restores the regional system settings (language, display of decimals, ...) after the execution of the Windows API.
This option is enabled by default.

Modifying the value of an option for API and CallDLL32 Hide the details

<Result> = APIParameter(<Option> , <Value>)

<Result>: Boolean

True if the requested option was enabled before using APIParameter,
False if the requested option was not enabled before using APIParameter.

<Option>: Integer constant

Parameter whose value must be modified:
apiLockThreads If <Value> is set to True, the threads are locked during the execution of API and CallDLL32.
If <Value> is set to False, the threads are not locked during the execution of API and CallDLL32.
This option is disabled by default.
apiRestoreSystemSettings If <Value> is set to True, the regional system parameters (language, display of decimals, ...) are restored after the execution of the Windows API.
If <Value> is set to False, the regional system parameters (language, display of decimals, ...) are not restored after the execution of the Windows API. In this case, the modifications will be stored if these parameters are modified by the Windows API.
This option is enabled by default.

<Value>: Boolean

Value of the requested option:
True if the requested option must be enabled,
False otherwise.

Component : wd240vm.dll