InitParameter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Control management functions

WLanguage procedure

InitParameter

Presentation

Example

Related examples

See also

InitParameter (Function)

In french: InitParamètre

Initializes the management of persistent values. Specifies the location used to store:

the values of the persistent controls.
the size and position of the controls and windows.
the values managed by SaveParameter and LoadParameter.

Remark: The initialization of persistent values is "global". Therefore, if a component initializes the management of persistent values, the management of persistent values will be initialized for the application that uses the component.

Example

// Parameters of persistent values
// in a .XML file that depends on the user
InitParameter(paramXML, "Param_" + USER + ".xml")

// Parameters of persistent values
// in a registry key with a version number
InitParameter(paramRegistry, ProjectInfo(piRegistry) + "\3.51")
// other possibility:
InitParameter(paramRegistry, "HKEY_CURRENT_USER\Software\DDSoft\DDTool\3.51")

// Parameters of persistent values
// Parameters via a string
MyString is string
MyString = fLoadText("MyFile.xml")
InitParameter(paramString, MyString)

Syntax

<Result> = InitParameter(<Initialization mode> [, <Source of values>])

<Result>: Character string

Initialization mode used before the call to InitParameter. <Result> has the following format:

<Initialization Mode> + TAB + <Source of Values>

<Initialization mode>: Integer constant

Type of backup for the persistent data:
paramIni The parameters will be saved in a ]Global[ section of a file in .INI format.
If this option is selected:
the INI file is named <Project name>.INI by default. This file is created in the directory of the executable.
This file is created in the "/Library" directory of the application.
This file is created in the "$HOME/.local/share" folder.
<Source of values> corresponds to the name of the .INI file to be used.
If this directory is not specified, the file is created in the executable directory.
If this directory is not specified, the file is created in the "/Library" directory of the application.
This file is created in the "$HOME/.local/share" folder.
paramRegistry The parameters will be saved in the registry.
If this option is selected:
by default, the entry used corresponds to the result of ProjectInfo(piRegistry) (which means HKEY_CURRENT_USER\Software\<Company>\<Project name>)
<Company> corresponds to the company specified when creating the executable. If this name is not specified, <Company> corresponds to "WINDEV applications".
in Test mode, the path used in the registry is as follows: HKEY_CURRENT_USER\SOFTWARE\PC SOFT\WinDev\28\TestMode\<Project name>.
<Source of values> corresponds to the registry entry to be used.
<Source of values> will be ignored. If this mode is chosen to store the persistent data, the support used for backup depends on the operating system on which the application is run. In Windows, the data is saved in the registry (HKEY_CURRENT_USER\Software\JavaSoft\Prefs) and in Mac OSX, the data is saved in the system preferences.
<Source of values> will be ignored. If this mode is chosen to store persistent data, the data is stored in the system preferences.
This parameter is not supported in this version.
paramString The parameters will be read in an XML string. <Source of values> (mandatory parameter) must be a string variable.
In this case, the parameters are not saved in an XML file but in the string variable.
This constant can be used to retrieve parameters coming from an HTTP server (parameters returned by HTTPRequest for example).
paramXML The parameters will be saved in a file in .XML format.
If this option is selected:
the XML file is named <Project name>.XML by default. This file is created in the directory of the executable.
This file is created in the "/Library" directory of the application.
This file is created in the "$HOME/.local/share" folder.
<Source of values> corresponds to the name of the .XML file to be used.
If this directory is not specified, the file is created in the executable directory.
If this directory is not specified, the file is created in the "/Library" directory of the application.
This file is created in the "$HOME/.local/share" folder.

<Source of values>: Optional character string

This parameter depends on the selected initialization mode.

Related Examples:

Training (WINDEV): WD Persistence

[ + ] This example presents the use of InitParameter, LoadParameter and SaveParameter.
These functions are used to configure the backup of controls, variables and other parameters.
This example is divided into three parts:
- The configuration
- The manual management of variables (SaveParameter and LoadParameter)
- The optimization
1°) Configuration

The configuration window enables you to modify the location of the backup of parameters (registry, INI file, XML file) as well as its path (registry key or file path).
2°) Manual management of the variables
The manual management enables you to save the content of the variables via SaveParameter and to restore them via LoadParameter. Each parameter is identified by a name. These values are saved at the location defined in the configuration window.
3°) The optimization
This window explains how to optimize your code to avoid the slowness caused when the saved values are restored. Indeed, when restoring the value of a control, its modification code is run. If you have long processes (queries with parameters for instance), this window shows you how to speed up the loading of the window.

Business / UI classification: Neutral code

Component: wd280std.dll