PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • 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 15 and later
Android This function is now available for the Android applications.
New in version 15
Android This function is now available for the Android applications.
Android This function is now available for the Android applications.
Versions 17 and later
Universal Windows 10 App This function is now available for the Windows Phone applications.
New in version 17
Universal Windows 10 App This function is now available for the Windows Phone applications.
Universal Windows 10 App This function is now available for the Windows Phone applications.
Versions 18 and later
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
New in version 18
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Versions 19 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 19
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Example
// Delete a parameter (syntax 1)
DeleteParameter("MyParameter")
WINDEVAndroidAndroid Widget iPhone/iPadWindows MobileJava
// Delete a parameter (syntax 1)
DeleteParameter("WIN_Window1\EDT_Edit1")
WINDEVAndroidAndroid Widget iPhone/iPadWindows MobileJava
// 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. 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),
  • WINDEVReports and QueriesiPhone/iPadWindows MobileJavaUser code (UMC) 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).
Java If the selected initialization mode is the registry, DeleteParameter is not sensitive to the case and to the accented characters found in the parameter name (Parameter and parameter are equivalent).
WINDEVReports and QueriesWindows MobileUser code (UMC)

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. To find out the error details, use 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. 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.
WINDEVReports and QueriesiPhone/iPadWindows MobileJavaUser code (UMC) 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

  • Versions 15 and later
    AndroidAndroid Widget In Android, the persistent values are saved in the Shared Preferences of the application.
    New in version 15
    AndroidAndroid Widget In Android, the persistent values are saved in the Shared Preferences of the application.
    AndroidAndroid Widget In Android, the persistent values are saved in the Shared Preferences of the application.
  • Versions 15 and later
    Universal Windows 10 App In Windows Phone, the persistent values are saved in the parameters of the application ("Isolated Storage Settings").
    New in version 15
    Universal Windows 10 App In Windows Phone, the persistent values are saved in the parameters of the application ("Isolated Storage Settings").
    Universal Windows 10 App In Windows Phone, the persistent values are saved in the parameters of the application ("Isolated Storage Settings").
  • Versions 19 and later
    iPhone/iPad In iOS, the persistent values are stored in the parameters of the application ("NSUserDefault").
    New in version 19
    iPhone/iPad In iOS, the persistent values are stored in the parameters of the application ("NSUserDefault").
    iPhone/iPad In iOS, the persistent values are stored in the parameters of the application ("NSUserDefault").
Components
WINDEVReports and Queries wd230std.dll
Windows Mobile wp230std.dll
Java wd230java.jar
Android wd230android.jar
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment