Local procedure

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Overview
Local procedure
Procedures local to a window
Procedures local to a page
Procedures local to a report
Creating a local procedure
Creation from the code editor
Creation from the "Project explorer" pane
Displaying the list of local procedures
Deleting a local procedure
Public or private local procedure

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Local procedure

Overview

Two types of procedures are available:

Global procedure: can be used in all the processes/events of the project. This global procedure is stored in the project.
Local procedure: can be used in all processes/events that depend on the object (window, page or report) in which this procedure was declared. This local procedure is stored in the object.

Important: You must not declare two procedures with the same name (especially a global procedure and a local procedure).

Reminder:

In WLanguage, there is no distinction between the procedures and the functions. The syntaxes for declaring and using procedures also apply to functions.
Versions 16 and later
You have the ability to create overloaded procedures. See Prototype overload for more details.
New in version 16
You have the ability to create overloaded procedures. See Prototype overload for more details.
You have the ability to create overloaded procedures. See Prototype overload for more details.

Versions 17 and later

This feature is available for iPhone/iPad applications.

New in version 17

This feature is available for iPhone/iPad applications.

Versions 18 and later

This feature is available in Windows Store apps mode.

This feature is available in Android Widget mode.

New in version 18

This feature is available in Windows Store apps mode.

This feature is available in Android Widget mode.

This feature is available in Windows Store apps mode.

This feature is available in Android Widget mode.

Versions 21 and later

This feature is available in Universal Windows 10 App mode.

This feature is available in Apple Watch mode.

New in version 21

This feature is available in Universal Windows 10 App mode.

This feature is available in Apple Watch mode.

This feature is available in Universal Windows 10 App mode.

This feature is available in Apple Watch mode.

Local procedure

Procedures local to a window

The local procedures declared in a window can be called from all processes/events:

of the window,
of the window controls,
of the local procedures associated with the window.

These procedures are stored in the window.

Limits:

The local procedures of a window cannot be used by its sibling windows.
The local procedures declared in a child window cannot be used in its parent window.

Procedures local to a page

The local procedures declared in a page can be called from all processes/events:

of the page,
of the page controls,
of the local procedures associated with the page.

These procedures are stored in the page.

You can declare in a page:

local server procedures. This type of local procedure contains WLanguage code that will be run on the server.
local browser procedures. This type of local procedure contains WLanguage code that will be run on the browser.
Versions 24 and later
mixed local procedures. This type of procedure can be run on both the server and the browser. The code of this procedure must be compatible (it must work on both the server AND the browser).
New in version 24
mixed local procedures. This type of procedure can be run on both the server and the browser. The code of this procedure must be compatible (it must work on both the server AND the browser).
mixed local procedures. This type of procedure can be run on both the server and the browser. The code of this procedure must be compatible (it must work on both the server AND the browser).

Limit: The local server procedures of a page cannot call the local browser procedures of a page and conversely.

Versions 24 and later
Remark: Mixed local procedure: This type of procedure can be run on both the server and the browser. The code of this procedure must be compatible (it must work on both the server AND the browser).
To use a specific server code and/or a specific browser code, you can use the following syntax:

<IF Browser>
// Code to be run only on the browser
<END>
<IF Server>
// Code to be run only on the server
<END>

New in version 24
Remark: Mixed local procedure: This type of procedure can be run on both the server and the browser. The code of this procedure must be compatible (it must work on both the server AND the browser).
To use a specific server code and/or a specific browser code, you can use the following syntax:

<IF Browser>
// Code to be run only on the browser
<END>
<IF Server>
// Code to be run only on the server
<END>

Remark: Mixed local procedure: This type of procedure can be run on both the server and the browser. The code of this procedure must be compatible (it must work on both the server AND the browser).
To use a specific server code and/or a specific browser code, you can use the following syntax:

<IF Browser>
// Code to be run only on the browser
<END>
<IF Server>
// Code to be run only on the server
<END>

Procedures local to a report

The local procedures declared in a report can be called from all processes/events:

of the report,
of report controls,
of the local procedures associated with the report.

These procedures are stored in the report.

Creating a local procedure

Creation from the code editor

To create a procedure local to the current element from the code editor:

Method 1:
- To create a local procedure, go to the "Code" pane, "Procedures" group, expand "New" and select "New local procedure" (or press F4).
- To create a local server procedure: on the "Code" pane, in the "Procedures" group, expand "New" and select "New local procedure (Server)".
- To create a local browser procedure: on the "Code" pane, in the "Procedures" group, expand "New" and select "New local procedure (Browser)".
- In the window that is displayed:
  - Specify the name of the procedure to create.
  - Versions 21 and later
    The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
    See Automatic documentation of procedures for more details.
    New in version 21
    The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
    See Automatic documentation of procedures for more details.
    The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
    See Automatic documentation of procedures for more details.
  - Versions 19 and later
    Specify the procedure scope. The created procedure is public by default. See Public or private local procedure for more details.
    New in version 19
    Specify the procedure scope. The created procedure is public by default. See Public or private local procedure for more details.
    Specify the procedure scope. The created procedure is public by default. See Public or private local procedure for more details.
Method 2:
- To create a local procedure: select "New .. New local procedure" from the popup menu.
- To create a local server procedure, select "New .. New local procedure (Server)".
- To create a local browser procedure, select "New .. New local procedure (Browser)".
- In the window that is displayed:
  - Specify the name of the procedure to create.
  - Versions 21 and later
    The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
    See Automatic documentation of procedures for more details.
    New in version 21
    The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
    See Automatic documentation of procedures for more details.
    The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
    See Automatic documentation of procedures for more details.
  - Versions 19 and later
    Specify the procedure scope. The created procedure is public by default. See Public or private local procedure for more details.
    New in version 19
    Specify the procedure scope. The created procedure is public by default. See Public or private local procedure for more details.
    Specify the procedure scope. The created procedure is public by default. See Public or private local procedure for more details.
Versions 22 and later
Method 3: To create a local procedure:
- Position the cursor in the event "Global declarations" of the window or page.
- Type the prototype of procedure to create.
- Validate. The local procedure is automatically created.
New in version 22
Method 3: To create a local procedure:
- Position the cursor in the event "Global declarations" of the window or page.
- Type the prototype of procedure to create.
- Validate. The local procedure is automatically created.
Method 3: To create a local procedure:
- Position the cursor in the event "Global declarations" of the window or page.
- Type the prototype of procedure to create.
- Validate. The local procedure is automatically created.

Remark: To transform a section of code already entered in a local procedure into a local procedure:

Select the corresponding code.
Select "New .. Create a local procedure containing the selected code" from the popup menu.
Specify:
- the procedure name.
- Versions 19 and later
  the procedure scope. The created procedure is public by default. For more details, see Public or private local procedure.
  New in version 19
  the procedure scope. The created procedure is public by default. For more details, see Public or private local procedure.
  the procedure scope. The created procedure is public by default. For more details, see Public or private local procedure.
The procedure is created, the corresponding code is replaced by the call to the procedure with the necessary parameters.

Remark: If the selected code is a server code, the created procedure will be a server procedure. If the selected code is a browser code, the created procedure will be a browser procedure.

Creation from the "Project explorer" pane

To create a local procedure from the "Project explorer" pane:

Select the element associated with the local procedure (window, page, report, ...).
Expand the element options and select "Local procedures".
Display the popup menu.
Select:
- "New local procedure".
- "New local server procedure".
- "New local browser procedure".
- Versions 24 and later
  "New mixed local procedure".
  New in version 24
  "New mixed local procedure".
  "New mixed local procedure".
In the window that is displayed:
- Specify the name of new local procedure.
- Versions 21 and later
  The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
  See Automatic documentation of procedures for more details.
  New in version 21
  The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
  See Automatic documentation of procedures for more details.
  The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
  See Automatic documentation of procedures for more details.
- Versions 19 and later
  Specify the procedure scope. The created procedure is public by default. See Public or private local procedure for more details.
  New in version 19
  Specify the procedure scope. The created procedure is public by default. See Public or private local procedure for more details.
  Specify the procedure scope. The created procedure is public by default. See Public or private local procedure for more details.
Validate.

Displaying the list of local procedures

To display the list of local procedures, press F8 in the code editor. The list of local procedures is displayed in the "Project explorer" pane.

By default, the F8 key lists the local server procedures. To display the list of local browser procedures, press Alt + F8 in the code editor. The list of local procedures is displayed in the "Project explorer" pane.

Deleting a local procedure

To delete a local procedure from the "Project explorer" pane:

Select the element associated with the local procedure (window, page, report, ...).
Expand the element options.
Expand the "Local procedures" option of the element.
Select the desired procedure.
Display the popup menu of the procedure and select "Delete".

Public or private local procedure

A local procedure is public by default: it is accessible from any code.

In some cases, it may be useful to restrict the access to a local procedure by making it "Private".

Versions 19 and later
When creating a local procedure, you have the ability to specify whether the procedure is public or private.

New in version 19
When creating a local procedure, you have the ability to specify whether the procedure is public or private.

When creating a local procedure, you have the ability to specify whether the procedure is public or private.

To modify the access mode to a local procedure:

Select the local procedure in the "Project explorer" pane.
In the popup menu of the procedure, select the new access mode::
- public.
- private.

Versions 16 and later
The color of the procedure bar changes according to its access mode:

red beginning of bar: private procedure.
standard beginning of bar: public procedure.

New in version 16
The color of the procedure bar changes according to its access mode:

red beginning of bar: private procedure.
standard beginning of bar: public procedure.

The color of the procedure bar changes according to its access mode:

red beginning of bar: private procedure.
standard beginning of bar: public procedure.

Remark: External component and private or public local procedures:
The use of private or public local procedures has an impact in the external components. Indeed, only the procedures explicitly declared as public (with the PUBLIC keyword used in their prototype) found in an external component cannot be accessed from the project that includes this component.