HDescribeLink (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

How to describe a link by programming?

List of HFSQL properties used to describe a link by programming

HCreateMoveableReplica

HCreateSubscriberReplica

HDeactivateAutoFilter

HDescribeFullTextIndex

HErrorStatusModification

HExecuteQuery

HExecuteQueryAsynchronous

HExecuteSQLQuery

HExecuteSQLQueryAsynchronous

HFilterIncludedBetween

HMigrateLinkedCompositeKey

HRecreateSubscriberReplica

How to describe a link by programming?
List of HFSQL properties used to describe a link by programming

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HDescribeLink (Function)

In french: HDécritLiaison

Not available with this kind of connection

Describes a link between two data files by programming.

After the call to HDescribeLink:

The description of the link is validated.
The link description cannot be modified anymore.
The variable for link description is reinitialized. A new link description can be done.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

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

New in version 21

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

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Example

HDescribeLink(CustomerProductLink)

Syntax

<Result> = HDescribeLink(<Link>)

<Result>: Boolean

True if the operation was performed,
False if a problem occurred. HErrorInfo is used to identify the error.

<Link>: Link Description variable

Name of the Link description variable that corresponds to the link to create.

Remarks

How to describe a link by programming?

To describe a link by programming, you must:

Use the Link description variables.
Describe the characteristics of the link via the HFSQL properties.
Use HDescribeLink to save the description of the link.

Remark: To describe a data file by programming, use HDescribeFile. To describe items by programming, use HDescribeItem.

List of HFSQL properties used to describe a link by programming

The following properties are available in read/write.


DeletionRule	..DeletionRule is used to configure the deletion rule (integrity management) that will be applied to the data file described by programming.
LinkedFile	..LinkedFile is used to configure the characteristics of a link.
LinkedKey	..LinkedKey is used to configure the characteristics of a link.
MaxLinkedCardinality	..MaxLinkedCardinality is used to find out and modify the maximum cardinality of the linked item in the link.
MaxSourceCardinality	..MaxSourceCardinality is used to find out and modify the maximum cardinality of the source item in the link.
MinLinkedCardinality	..MinLinkedCardinality is used to find out and modify the minimum cardinality of the linked item in the link.
MinSourceCardinality	..MinSourceCardinality is used to find out and modify the minimum cardinality of the source item in the link.
ModificationRule	..ModificationRule is used to configure the modification rule of the records (integrity management) that will be applied to the data file described by programming.
Name	..Name is used to find out: the name of the font associated with a Font variable. the name of a control, report or report block. the name of a control, group of controls or window. the name of a control, group of controls or page.
SourceFile	..SourceFile is used to configure the characteristics of a link.
SourceKey	..SourceKey is used to configure the characteristics of a link.

Component : wd260hf.dll