GetDefinition (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Retrieving the definition
Limits

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

GetDefinition (Function)

In french: RécupèreDéfinition

Retrieves the definition of element type.

Versions 18 and later

This function is now available in Windows Store apps mode.

This function is now available for iPhone/iPad applications.

New in version 18

This function is now available in Windows Store apps mode.

This function is now available for iPhone/iPad applications.

This function is now available in Windows Store apps mode.

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

Example

PROCEDURE Proc(x)
// Retrieves the definition of x type
MyDefinition is Definition
MyDefinition = GetDefinition(x)

Syntax

<Result> = GetDefinition(<Element>)

<Result>: Definition

Definition variable.

<Element>: Variable or class member

Element for which the definition will be retrieved.

Remarks

Retrieving the definition

GetDefinition is used to retrieve the definition of content type (and not the definition of variable type).

Example:

If two classes "DerivedClasse" and "BaseClass" derive from each other. If the instances of "DerivedClass" and "BaseClass" are handled by a "dynamic BaseClass" variable, GetDefinition returns the definition of real class of instance.

po is dynamic BaseClass
d is Definition

po = new BaseClass
d = GetDefinition(po)
Trace(d.Name)

po = new DerivedClass
d = GetDefinition(po)
Trace(d.Name)

If the type of the element is not supported, GetDefinition returns a Null definition with a non-fatal error ("Invalid definition").

If the element is not allocated, GetDefinition returns a Null definition with a non-fatal error ("Element not allocated").

The error cases can be processed:

by comparing the description to Null.
by checking the value of the ErrorOccurred variable.

The following types of elements are supported:

native variables and members
advanced variables and members
variables and members of type class
variables and members of type structure

The following types of elements are not supported:

variables and members of .NET type
windows, reports, pages, controls, etc.
HFSQL files, queries, items, etc.

Limits

In a project, you cannot retrieve the definition of an instance coming from:
- an external component.
- an internal component.
In an external component, you cannot retrieve the definition of an instance coming from the host project.

Component: wd270vm.dll