- Finding out the version number of the external component
- Information about a WINDEV/WEBDEV library
- Searching for the patch number accepted by an external component
- Searching for the patch number accepted by the WINDEV/WEBDEV elements
- External components sharing the context of the project
ComponentInfo (Function) In french: ComposantInfo Returns information about an external component. This external component corresponds to: - an external component included in the current project.
- the current project used to define and generate an external component.
- an external component not included in the current project.
Remark: For a WINDEV/WEBDEV library (WDL file), this function is also used to know: - the version number.
 Versions 23 and laterthe generation date.  New in version 23the generation date.
// Information about the OverviewComp component
Trace(ComponentInfo(OverviewComp, ciVersion))
// Information about the OverviewComp component
// found in "C:\MyDirectory"
Trace(ComponentInfo(OverviewComp, ciVersion, "C:\MyDirectory"))
// Information about the current component
Trace(ComponentInfo("", ciVersion))
// Information about an external component
Trace(ComponentInfo("", ciVersion, "D:\MyComponents\MyComponent.WDK"))
Syntax
Finding out information about an external component included in the current project Hide the details
<Result> = ComponentInfo(<Component name> , <Sought information> [, <Component directory>])
<Result>: Character string Requested information. <Component name>: Character string Logical name of the external component (displayed in the editor). A WLanguage error occurs if the name of external component is unknown. <Sought information>: Integer constant Information about the component:
| | Versions 15 and laterciGlobalCommponent New in version 15ciGlobalCommponent ciGlobalCommponent | Load mode of the external component:- True if the external component was loaded globally.
- False if the external component is isolated
| | ciLoadedAtStartup | Load the external component as soon as the project is started:- True if the external component was loaded when starting the project.
- False otherwise.
| | ciCopyright | Copyright of the component | Versions 23 and laterciGenerationDate New in version 23ciGenerationDate ciGenerationDate | Date on which the component or library (WDL file) was generated. | | ciStatus | Status of external component. This status corresponds to one of the following variables:- cisAbsent: WDK file known to the project but not found physically
- cisLoaded: WDK file already loaded
- cisUnknown: WDK file unknown to the project
- cisReady: WDK file ready to be used
- cisVersionTooOld: WDK file too old
- cisVersionTooRecent: WDK file too recent and not compatible
| | ciCaption | Caption of the component. | | ciPhysicalName | Name of physical file associated with the external component. | | ciPatchNumber | Number of first patch accepted by the external component. | | ciOwner | Company that publishes the external component. | | ciCompany | Company that publishes the external component (same as ciOwner) | | ciVersion | Real version of the component or library (WDL file). | | ciCompatibleVersion | Compatible version of the component | | ciInternalVersion | Version of WINDEV or WEBDEV that was used to create the component | | ciProjectVersion | Version of the component that was used to compile the project |
<Component directory>: Optional character string Directory of the <Component name> external component (WDK file). This parameter is ignored if <Component name> is already loaded.
Getting information about the current project used to define and generate an external component Hide the details
<Result> = ComponentInfo(<Component name> , <Sought information>)
<Result>: Character string Requested information. <Component name>: Character string Empty string (""). The current external component will be used. This project is used to define and generate an external component. <Sought information>: Integer constant Information available about the current external component:
| | Versions 15 and laterciGlobalCommponent New in version 15ciGlobalCommponent ciGlobalCommponent | Load mode of the external component:- True if the external component was loaded globally.
- False if the external component is isolated
| | ciCopyright | Copyright of external component. | Versions 23 and laterciGenerationDate New in version 23ciGenerationDate ciGenerationDate | Date on which the component or library (WDL file) was generated. | | ciStatus | Status of external component. This status corresponds to the cisLoaded constant: WDK file already loaded. | | ciCaption | Caption of external component. | | ciLogicalName | Logical name of external component. | | ciPhysicalName | Name of physical file associated with the external component. | | ciPatchNumber | Number of first patch accepted by the external component. | | ciOwner | Company that publishes the external component. | | ciVersion | Real version of the external component or library (WDL file). | | ciCompany | Company that publishes the external component (same as ciOwner). | | ciCompatibleVersion | Compatible version of external component. | | ciInternalVersion | WINDEV or WEBDEV version that was used to create the external component. | | ciProjectVersion | Version of external component that was used to compile the project. |
Getting information about an external component not included in the current project Hide the details
<Result> = ComponentInfo(<Component name> , <Sought information> [, <Component physical name>])
<Result>: Character string Requested information. <Component name>: Character string Empty string (""). The external component named <Component physical name> will be used. <Sought information>: Integer constant Information available about the external component:
| | Versions 15 and laterciGlobalCommponent New in version 15ciGlobalCommponent ciGlobalCommponent | Load mode of the external component:- True if the external component was loaded globally.
- False if the external component is isolated
| | ciCopyright | Copyright of external component. | Versions 23 and laterciGenerationDate New in version 23ciGenerationDate ciGenerationDate | Date on which the component or library (WDL file) was generated. | | ciStatus | Status of external component. This status corresponds to one of the following constants:- cisAbsent: WDK file not found physically
- cisReady: WDK file ready to be used
| | ciCaption | Caption of external component. | | ciLogicalName | Logical name of external component. | | ciPhysicalName | Name of physical file associated with the external component. | | ciPatchNumber | Number of first patch accepted by the external component. | | ciOwner | Company that publishes the external component. | | ciCompany | Company that publishes the external component (same as ciOwner). | | ciVersion | Real version of the external component or library (WDL file). | | ciCompatibleVersion | Compatible version of external component. | | ciInternalVersion | WINDEV or WEBDEV version that was used to create the external component. | | ciProjectVersion | Information not available. <Result> will be equal to "" (empty string). |
<Component physical name>: Optional character string Name and full path of the external component (WDK file). Remarks Finding out the version number of the external component If the version of an external component loaded when starting the project is incorrect in relation to the project, a WLanguage error occurs before running the initialization code of the project. To test the version of an external component by programming (ciVersionXX or ciStatus constant), the external component must be loaded when first used. The load mode of an external component is defined in the description window of the external component imported into the project ("General" tab). Information about a WINDEV/WEBDEV library To find out: - the version number of a WINDEV/WEBDEV library (WDL file), use the following syntax:
ComponentInfo("", ciVersion, <WDL physical name>)
Versions 23 and laterthe generation date of a WINDEV/WEBDEV library (WDL file), use the following syntax:
ComponentInfo("", ciGenerationDate, <WDL physical name>)
New in version 23the generation date of a WINDEV/WEBDEV library (WDL file), use the following syntax:
ComponentInfo("", ciGenerationDate, <WDL physical name>)
the generation date of a WINDEV/WEBDEV library (WDL file), use the following syntax:
ComponentInfo("", ciGenerationDate, <WDL physical name>)
Searching for the patch number accepted by an external component To be taken into account: - A patch must have been created from the same project configuration as the external component.
- The patch number of a patch must be greater than or equal to the patch number of the external component.
Searching for the patch number accepted by the WINDEV/WEBDEV elements - To find out the patch number of the first patch accepted by the application (EXE file), use the following syntax:
ComponentInfo("", ciPatchNumber, <Executable physical name>)
- To find out the patch number of the first patch accepted by the library (WDL file), use the following syntax:
ComponentInfo("", ciPatchNumber, <WDL physical name>)
Remark: The full example of this function presents a solution for listing the patches used by an application. Remark: To be taken into account: - A patch must have been created from the same project configuration as the executable or the library.
- The patch number of a patch must be greater than or equal to the patch number of the executable or library.
External components sharing the context of the project The information returned by ComponentInfo is not available for the components that share the project context. The function returns "" (empty string).
This page is also available for…
|
|
|