DeleteParameter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Control management functions

Detailed example for deleting a parameter (syntax 1)

Special cases

See also

DeleteParameter (Function)

In french: SupprimeParamètre

Deletes a parameter or a set of saved parameters:

with the SaveParameter function,
automatically via the data persistence in the controls.

Caution: This operation is irreversible and it cannot be undone.

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 17 and later

This function is now available for Windows Phone applications.

New in version 17

This function is now available for Windows Phone 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 19 and later

This function is now available for iPhone/iPad applications.

New in version 19

This function is now available for iPhone/iPad applications.

Versions 21 and later

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

New in version 21

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

Versions 24 and later

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

New in version 24

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

Versions 27 and later

This function is now available for WINDEV applications in Linux.

New in version 27

This function is now available for WINDEV applications in Linux.

Example

// Delete a parameter (syntax 1)
DeleteParameter("MyParameter")

// Delete a parameter (syntax 1)
DeleteParameter("WIN_Window1\EDT_Edit1")

// Delete parameters from the "WIN_Win1" window (syntax 2)
DeleteParameter(WIN_Win1)
// equivalent to: DeleteParameter(WIN_Win1..FullPath)

Syntax

Deleting a saved parameter Hide the details

<Result> = DeleteParameter(<Parameter name>)

<Result>: Boolean

True if the function was successful,
False otherwise. If an error occurs, you can get more details on the error with ErrorInfo.

<Parameter name>: Character string

Name of parameter to delete. This parameter is sought:
in the registry (or equivalent file on the runtime platform),
in the parameter file specified by InitParameter.
This name can be a value or a full path (the accepted separators are the dot (.) and the slash (\)). For a full path, all the values found "below" this path will be deleted (see example in the Notes section).
If the selected initialization mode is the registry, DeleteParameter is case and accent-insensitive (Parameter and parameter are equivalent).

Deleting all the parameters saved for the specified element Hide the details

<Result> = DeleteParameter(<Element name>)

<Result>: Boolean

True if the function was successful,
False otherwise. If an error occurs, you can get more details on the error with ErrorInfo.

<Element name>: Character string

Name of the control or window whose saved parameters must be deleted. This element is sought in the parameter file specified by InitParameter (in the registry by default).

Deleting all the saved parameters Hide the details

<Result> = DeleteParameter()

<Result>: Boolean

True if the function was successful,
False otherwise. If an error occurs, you can get more details on the error with ErrorInfo.
All the parameters saved by the application are deleted. During the next start, the application will behave like if it was its first start.
The parameter file of the application specified by InitParameter is entirely cleared. If the parameters have been saved in a INI or XML file, this file is deleted.

Remarks

Detailed example for deleting a parameter (syntax 1)

In this example, the deleted elements are highlighted.


Code used	Backup file: Registry	Backup file: XML
DeleteParameter ("Param1")	`HKEY_CURRENT_USER \Software \<Company> \<Application> Param1 Param2`	<Param1> Value </Param1>
DeleteParameter ("Window1\Edit2\X")	`HKEY_CURRENT_USER \Software \<Company> \<Application> \Window1\ Edit2 X Y`	<Window1> <Edit2> <X>Value </X> <Y>Value </Y> </Edit2> </Window1>
DeleteParameter ("Window1\Edit2")	`HKEY_CURRENT_USER \Software \<Company> \<Application> \Window1 \Edit2 X Y`	<Window1> <Edit2> <X>Value </X> <Y>Value </Y> </Edit2> </Window1>

<Company> corresponds to the company specified when creating the executable. If this name is not specified, <Company> corresponds to "WINDEV applications".

Special cases

Versions 15 and later
In Android, the persistent values are saved in the Shared Preferences of the application.
New in version 15
In Android, the persistent values are saved in the Shared Preferences of the application.
In Android, the persistent values are saved in the Shared Preferences of the application.
Versions 15 and later
In applications in Universal Windows App mode, the persistent values are saved in the parameters of the application ("Isolated Storage Settings").
New in version 15
In applications in Universal Windows App mode, the persistent values are saved in the parameters of the application ("Isolated Storage Settings").
In applications in Universal Windows App mode, the persistent values are saved in the parameters of the application ("Isolated Storage Settings").
Versions 19 and later
In iOS, the persistent values are stored in the parameters of the application ("NSUserDefault").
New in version 19
In iOS, the persistent values are stored in the parameters of the application ("NSUserDefault").
In iOS, the persistent values are stored in the parameters of the application ("NSUserDefault").
Versions 24 and later
In a WEBDEV site, persistent values are stored in a browser cookie.
New in version 24
In a WEBDEV site, persistent values are stored in a browser cookie.
In a WEBDEV site, persistent values are stored in a browser cookie.

Business / UI classification: Neutral code

Component: wd270std.dll