ComponentLoad (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Loading an external component

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ComponentLoad (Function)

In french: ComposantCharge

Loads the specified external component in memory. This external component will be loaded in memory until the end of the application.

Remarks:

The mode for loading the external component (when starting the project or when using a component element for the first time) is defined when the component is included in the project.
The following processes are run when the component is loaded:
- process for declaring the classes of the external component.
- process for declaring the sets of procedures of the external component.
- initialization process of the external component.

Example

// Load the external component
ResLoad is int
ResLoad = ComponentLoad(MyComponent, "C:MyApplication")
SWITCH ResLoad
CASE cisAbsent:
Error("The specified path does not correspond to the specified external component")
CASE cisVersionTooOld, cisVersionTooRecent:
Error("The version of the external component is not compatible with the executable")
CASE cisLoaded:
Info("The external component is loaded")
END

Syntax

<Result> = ComponentLoad(<Component name> [, <Component directory> [, <Load mode>]])

<Result>: Integer constant

Status report of the load operation:
cisAbsent The external component is not found in the specified path.
cisLoaded The external component was successfully loaded.
cisVersionTooOld The version of external component is too old. It is not compatible with the current executable.
cisVersionTooRecent The version of external component is too recent. It is not compatible with the current executable.

<Component name>: Character string (with or without quotes)

Name of the external component (as it appears in the editor) to load. A WLanguage error occurs if the name of external component is unknown.

<Component directory>: Optional character string (with quotes)

Directory of the external component (WDK file) to load. This directory may (or may not) end with a "\". A full path, a relative path or a UNC path can be used.
If this parameter is not specified, the external component will be sought:
first, in the directory specified in the <Component directory> parameter of ComponentLocate.
then, in the directory specified in the "<Component name>.INI" file. See Deploying an application that uses an external component for more details.
finally, in the EXE directory of the project.

<Load mode>: Optional Integer constant

Versions 15 and later
Load mode of external component. Corresponds to one of the following constants:
ccGlobal The external component is loaded globally. For example, the same context will be used if the component is loaded by the project and by a project component.
ccIsolated
(Default value) The external component is isolated. For example, if the component is loaded by the project and by a project component, each component will be using a specific context.
New in version 15
Load mode of external component. Corresponds to one of the following constants:
ccGlobal The external component is loaded globally. For example, the same context will be used if the component is loaded by the project and by a project component.
ccIsolated
(Default value) The external component is isolated. For example, if the component is loaded by the project and by a project component, each component will be using a specific context.
Load mode of external component. Corresponds to one of the following constants:
ccGlobal The external component is loaded globally. For example, the same context will be used if the component is loaded by the project and by a project component.
ccIsolated
(Default value) The external component is isolated. For example, if the component is loaded by the project and by a project component, each component will be using a specific context.

Remarks

Loading an external component

The mode for loading the external component (when starting the project or when using a component element for the first time) is defined when the component is included in the project.

To modify this load mode:

Display the list of external components imported into the project:
- In the "Project explorer" pane, select the "External components" folder.
- Display the popup menu of the folder and select "List of external components imported into the project".
Select the desired component and click "Description".
Modify the load mode ("Load mode of component").

Reminder: The following events are run when a component is loaded:

declaration event of the classes of the external component.
declaration event of the sets of procedures of the external component.
initialization event of the external component.

Component : wd250vm.dll