ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / WLanguage syntax / Reserved keywords
  • General properties on the parameters of a procedure
  • Handling the parameters of a procedure
  • Specific properties that can be used on each parameter of a procedure
  • Re-stacking parameters
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
MyParameters (Reserved word)
In french: MesParamètres
The MyParameters keyword is used to handle the parameters passed to a WLanguage procedure. It allows you to access the advanced information about the parameters of the current WLanguage procedure.
You have the ability to handle all the parameters or a single parameter.
This keyword can be used in the standard WLanguage procedures and in the WLanguage procedures with a variable number of parameters.
Example
// Procedure used to shift controls
PROCEDURE ShiftControl(*)

// This code uses a POUR loop ... _A_ 
// to avoid recalculating the number of parameters at each iteration
// Indeed, this number of parameters is fixed. 
FOR I = 1 _TO_ MyParameters..Count
	MyParameters[I]..X += 10
END
Syntax
MyParameters
Remarks

General properties on the parameters of a procedure

Two properties can be used on all the parameters of a WLanguage procedure:
Property nameEffect
NbReceivedReturns the number of parameters actually received by the current WLanguage procedure.
OccurrenceReturns the number of parameters that can be used in the current WLanguage procedure.
WEBDEV - Browser code This property is not available.
Example: PROCEDURE Proc(p1, po2= "Y", po3 = "Z")
CallProc("A")Proc("A", "B")Proc("A","B", "C")
MyParameters..NbReceived123
MyParameters..Count333
The special parameter "*" (that is used to keep the default value) is counted as a received parameter.

Handling the parameters of a procedure

The standard WLanguage operations are available on each one of the procedure parameters via the following notation MyParameters[N] where N is the number of the parameter to use.
For example:
  • MyParameters[N]: Retrieves the value of the procedure's Nth parameter.
  • MyParameters[N] =: Assigns the value of the Nth parameter in the procedure.
  • MyParameters[N]++, MyParameters[N]+=, ... Combined arithmetic operations.
  • MySettings[N]..<Property Name>: Access to a property of the element.
  • MyParameters[N][...]: Access to parameter value-indexed sub-elements.
  • MySettings[N].<Sub-element>: Access to a sub-element of the parameter value.
  • MySettings[N]:<Member>: Access to a member of the parameter value
  • MySettings[N]>>xxx: Automation syntax.
Note: You can find out the type of a parameter by using the GetDefinition function.

Specific properties that can be used on each parameter of a procedure

The following properties can be used on the parameters received by a procedure:
Property nameEffect
DefaultUsed to find out whether the value of the parameter is the one passed by default or if it was explicitly specified.
ByAddress / ByReferenceUsed to find out whether the parameter was passed by default or by address.
WEBDEV - Browser code These properties are not available in browser code.

Re-stacking parameters

The MyParameters keyword is a simple way of restacking the parameters of a WLanguage procedure: the parameters (or part of the parameters) of the current procedure can be passed to another WLanguage procedure or function.
The possible syntaxes are:
  • MyParameters: re-stores all procedure parameters.
  • MyParameters[2 A]: restarts all procedure parameters from the second one.
  • MyParameters[A 3]: restarts all procedure parameters up to and including the third.
  • MyParameters[2 A 4]: restores all procedure parameters from the second to the fourth.
  • MyParameters[2 ON 3]: re-starts from the second of three procedure parameters.
  • MyParameters[*]: re-stores additional parameters.
Note: Parameter re-stacking does not generate a WLanguage error if the requested parameters do not exist: missing parameters are ignored.
Example: Overrides the function Opens for writing to a trace file:
PROCÉDURE Open(WinName, *)
Trace(WinName)
WL.Open(WinName, MyParameters[2 TO ])
WEBDEV - Browser code This feature is not available.
Minimum version required
  • Version 11
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 10/04/2024

Send a report | Local help