HListLink (Function)

// Retrieve the links of the CUSTOMER data file in the current analysis
ListLink is string
ListLink = HListLink(CUSTOMER, hLstDetail)
// Adds the list of links in COMBO_COMBO1
ListAdd(COMBO_COMBO1, ListLink)

// Retrieve the links of an HFSQL Client/Server database
// independently of the current analysis
CntHFSQL is Connection
CntHFSQL..Provider = hAccessHFClientServer
CntHFSQL..User = "admin"
CntHFSQL..Password = ""
CntHFSQL..Server = "HFSQLServer:4900"
CntHFSQL..Database = "CRM"
HOpenConnection(CntHFSQL)
ListLink is string = HListLink("*", CntHFSQL)
// Adds the list of links in COMBO_COMBO1
ListAdd(COMBO_COMBO1, ListLink)

Syntax

Listing the links of an analysis Hide the details

<Result> = HListLink([<Data file> [, <Path of WDD> [, <Password of WDD>]]] [, <Options>])

<Result>: Character string

List of links. The different link descriptions are separated by CR characters (Carriage Return). The result is more or less detailed depending on the constant used:
hLstDetail is not specified <Name link1> + TAB + <Name file1.1> + TAB + <Name item1.1> + TAB + <Cardinality 1.1> + TAB + <Name file1.2> + TAB + <Name item1.2> + TAB + <Cardinality 1.2> + CR +...
hLstDetail is specified <Name link1> + TAB + <Name file1.1> + TAB + <Name item1.1> + TAB + <Cardinality 1.1> + TAB + <Name file1.2> + TAB + <Name item1.2> + TAB + <Cardinality 1.2> + TAB + <Modification rule> + TAB + <Deletion rule> + CR +...

Where:
<Name link X>: name of the link.
<Name file x.1>:: Name of the data file related to the primary key.
<Name item x.1>: Name of the item related to the primary key or name of the specified data file.
<Cardinality x.1>: Cardinality of the link related to the primary key in the following format: "<Min cardinality>, <Max cardinality>" ("0, N" or "1, N" for example).
<Name file x.2>: Name of the data file related to the foreign key.
<Name item x.2>: Name of the item related to the foreign key.
<Cardinality x.2>: Cardinality of the link related to the foreign key in the following format: "<Min cardinality>, <Max cardinality>" ("0, N" or "1, N" for example).
<Modification rule>: Rule to apply if the primary key is modified.
<Deletion rule>: Rule to apply if the primary key is deleted.
The name of data files corresponds to the name of the database + '\' + the relative physical name of these data files.
If one of the listed links is performed in a composite key, the <Name item 1.2> parameter returned will correspond to the name of the different key components. The names will be separated by a comma.

<Data file>: Optional character string (with or without quotes)

Name of the data file whose links must be listed. The links originating from this file or ending at this file are listed.
If this parameter is corresponds to "*", HListLink lists the links defined for all the data files defined in the analysis.

<Path of WDD>: Optional character string

Full path of the analysis file (.WDD file). If this parameter is not specified or if it is equal to an empty string (""), the links are sought in the current analysis.

<Password of WDD>: Optional character string

Password defined for the analysis. If no password is defined, this parameter must be equal to an empty string ("").

<Options>: Optional integer constant

Configures the type of list to perform:
hLstDetail Lists the detailed information about the links.
hLstNormal
(default value) Lists the links.
This parameter is ignored.

Listing the links of a connection via Native Access or OLE DB or the links of an HFSQL Client/Server connection Hide the details

<Result> = HListLink([<Data file> [, <Connection name>]] [, <Options>])

<Result>: Character string

List of links. The different link descriptions are separated by CR characters (Carriage Return). The result is more or less detailed depending on the constant used:
hLstDetail is not specified <Name link1> + TAB + <Name file1.1> + TAB + <Name item1.1> + TAB + <Cardinality 1.1> + TAB + <Name file1.2> + TAB + <Name item1.2> + TAB + <Cardinality 1.2> + CR +...
hLstDetail is specified <Name link1> + TAB + <Name file1.1> + TAB + <Name item1.1> + TAB + <Cardinality 1.1> + TAB + <Name file1.2> + TAB + <Name item1.2> + TAB + <Cardinality 1.2> + TAB + <Modification rule> + TAB + <Deletion rule> + CR +...

Where:
<Name link X>: name of the link.
<Name file x.1>:: Name of the data file related to the primary key.
<Name item x.1>: Name of the item related to the primary key or name of the specified data file.
<Cardinality x.1>: Cardinality of the link related to the primary key in the following format: "<Min cardinality>, <Max cardinality>" ("0, N" or "1, N" for example).
<Name file x.2>: Name of the data file related to the foreign key.
<Name item x.2>: Name of the item related to the foreign key.
<Cardinality x.2>: Cardinality of the link related to the foreign key in the following format: "<Min cardinality>, <Max cardinality>" ("0, N" or "1, N" for example).
<Modification rule>: Rule to apply if the primary key is modified.
<Deletion rule>: Rule to apply if the primary key is deleted.
The name of data files corresponds to the name of the database + '\' + the relative physical name of these data files.
If one of the listed links is performed in a composite key, the <Name item 1.2> parameter returned will correspond to the name of the different key components. The names will be separated by a comma.

<Data file>: Optional character string (with or without quotes)

Name of the data file whose links must be listed. The links originating from this file or ending at this file are listed.
If this parameter is corresponds to "*", HListLink lists the links defined for all the data files defined in the analysis.
This parameter can correspond to a name unknown to the HFSQL engine, only existing on the database server.
The name of the data file found in first position corresponds to the data file related to the primary key.

<Connection name>: Optional character string (with or without quotes)

Name of the connection, defined in the data model editor or by programming with HDescribeConnection.

<Options>: Optional integer constant

Configures the type of list to perform:
hLstDetail Lists the detailed information about the links.
hLstNormal
(default value) Lists the links.
This parameter is ignored.

Remarks

Displaying the result in a List Box or Combo Box control

<Result> can be directly assigned to a List Box or Combo Box control by ListAdd. Each row will contain the full name of one of the links found.

Deletion and modification rule

The modification rules and the deletion rules returned by HListLink can correspond to the following constants:


hIntegrityNone	No integrity constraint.
hIntegrityCascade	Manage the cascading modification and deletion.
hIntegrityForbidden	Strict respect of integrity.
hIntegrityDefaultValue	During the deletion, a default value is assigned to the linked records.

Component : wd240hf.dll