PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • Detailed example for deleting a parameter (syntax 1)
  • Special cases
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
DeleteParameter (Function)
In french: SupprimeParamètre
Deletes a parameter (or set of parameters) that was saved:
Caution: This operation is irreversible and it cannot be undone.
Versions 24 and later
Windows This function is now available for the WEBDEV sites in Windows.
New in version 24
Windows This function is now available for the WEBDEV sites in Windows.
Windows This function is now available for the WEBDEV sites in Windows.
Example
// Delete a parameter (syntax 1)
DeleteParameter("MyParameter")
Syntax

Deleting a saved parameter Hide the details

<Result> = DeleteParameter(<Parameter name>)
<Result>: Boolean
  • True if the function was successful,
  • False otherwise. To find out the error details, use ErrorInfo.
<Parameter name>: Character string
Name of parameter to delete. This parameter is sought:
  • in the registry (or equivalent file on the runtime platform),
  • Reports and Queries 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).
Reports and Queries

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, use ErrorInfo to know the error details.
<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).
Reports and Queries

Deleting all the saved parameters Hide the details

<Result> = DeleteParameter()
<Result>: Boolean
  • True if the function was successful,
  • False otherwise. To find out the error details, use 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.
Reports and Queries 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 usedBackup file: RegistryBackup 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

    Component : wd240std.dll
    Minimum version required
    • Version 9
    This page is also available for…
    Comments
    Click [Add] to post a comment