AppChangeParameter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Application update functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

AppChangeParameter (Function)

In french: AppliChangeParamètre

Warning
From version 23, AppliChangeParameter is kept for backward compatibility. This function has been replaced with AppChangeParameter.

Changes an information in the mechanism for automatic application update.

Example

IF AppParameter(appUPDMode) = 3 THEN
	AppChangeParameter(appUPDMsgStop, "L'application " + ProjectInfo(piEXEName) + ...
			"va être arrêtée automatiquement.")
END

Syntax

<Result> = AppChangeParameter(<Information> , <New value> [, <Application path>])

<Result>: Boolean

True if the requested information was modified,
False if a problem occurs. For more details on the error, use ErrorInfo.

<Information>: Integer constant

Characteristic of the application to modify:
appUPDAutoCheck Enable automatic check for updates:
True to enable,
False to disable.
appUPDBackgroundTask Download application updates from the Private Store in the background.
If the application is in use, it is not interrupted.
When the update is downloaded, a notification is displayed to install the update. If necessary, the notification is also displayed next time the application is launched.
Please note: This constant is only taken into account for applications in the Private Store.
Not available.
appUPDDisplayError Allows you to display a message if a problem is encountered when checking for updates:
True to display a message,
False otherwise.
Constant not available.
appUPDDisplayMode Display options for update notifications:
0: A window in the application is used to warn the user.
1: A Notification is used to alert the user.
Constant not available.
appUPDLocalVersion Version number of local executable.
appUPDMode Current operating mode of the application:
0: Normal operation.
1: Launch prohibited: current executables continue to run.
2: Launch prohibited: executables in progress receive a warning message periodically.
3: Launch prohibited: executables in progress are automatically stopped after a certain time.
appUPDMsgForbid Message displayed when the startup of the application is forbidden.
appUPDMsgStop Message displayed before the application is automatically stopped (when appUPDMode = 3).
appUPDMsgWarning Message displayed on a regular basis (when appUPDMode = 2).
appUPDNetwork Level of update:
0: No update.
The update in network is not used.
1: Network update enabled.
The available updates are checked and the dialog box of automatic update is displayed.
2: Network update enabled and applications registered with update server.
The available updates are checked and the dialog box of automatic update is displayed.
As soon as it is started, the executable creates a ".LOK" file on the server. This file allows WDAdminExe to identify the clients that use the application.
appUPDPath Path of update information on the server.
appUPDProtocol Network protocol used to search for updates. This protocol can correspond to "LOCAL" or to "HTTP".
appUPDServer Server where the updates will be sought.
If the HTTP protocol is used, IP address or name of computer.
If the LOCAL protocol is used, name of network share.
appUPDTimeout Timeout between two messages (if appUPDMode = 2) or before the application is automatically stopped (if appUPDMode = 3). This timeout is expressed in seconds.

<New value>: Expected type

New value that will be given to the specified information.

<Application path>: Optional character string

Full path of executable to use. If this parameter is not specified, the current application will be handled.

Remarks

The new parameters will be taken into account the next time the application is started.

Business / UI classification: Business Logic

Component: wd300std.dll