HDeleteLink (Function)

The deletion will be effective for the application that performed it once the connection has been closed and re-opened. Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Versions 22 and later

This function is now available for iPhone/iPad applications.

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

New in version 22

This function is now available for iPhone/iPad applications.

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

This function is now available for iPhone/iPad applications.

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

Example

MyConnection is Connection
MyLink is Link Description
// Describe the "LIVES" link
MyLink..SourceFile = ".\city.fic"
MyLink..LinkedFile = ".\customer.fic"
MyLink..SourceKey = "CITYNAME"
MyLink..LinkedKey = "CUSTCITY"

// Default link (0-1, 0-1)
HDeleteLink(MyConnection, MyLink)

// Delete all links from a database
// found on a HFSQL Client/Server server
// 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)

sListLinks is string = HListLink("*", CntHFSQL)
sALinkInfo is string
ALink is Link Description

FOR EACH STRING sALinkInfo OF sListLinks SEPARATED BY CR
IF sALinkInfo <> "" THEN
ALink..Name = ExtractString(sALinkInfo, 1, TAB)
ALink..SourceFile = Replace(ExtractString(sALinkInfo, 2, TAB), ...
CntHFSQL..Database, ".", IgnoreCase)
ALink..SourceKey = ExtractString(sALinkInfo, 3, TAB)
ALink..LinkedFile = Replace(ExtractString(sALinkInfo, 5, TAB), ...
CntHFSQL..Database, ".", IgnoreCase)
ALink..LinkedKey = ExtractString(sALinkInfo, 6, TAB)
// Delete the link from the HFSQL Client/Server server
Trace("Deletion >> " + ALink..Name + " >> " + ...
HDeleteLink(CntHFSQL, ALink))
END
END

Syntax

<Result> = HDeleteLink(<Source connection> [, <Linked connection>] , <Link description>)

<Result>: Boolean

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

<Source connection>: Character string (with or without quotes) or Connection variable

Connection to which belongs the source file of the link. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a Connection variable.

<Linked connection>: Optional character string (with or without quotes) or Connection variable

Connection to which belongs the linked file of the link. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a Connection variable.
If this parameter is not specified, both data files will belong to the same connection (<Source connection>).

<Link description>: Link Description variable

Name of the Link description variable containing the characteristics of the link to delete. The link to delete is defined by the source data file, the source item and the linked item.

Remarks

Link description

The names of the data files in the link description (..SourceFile and ..LinkedFile) must correspond to the physical name of the files, relative to the relevant database. The database of each data file is returned by the <Source connection> and <Linked connection> parameters

To delete a link, there is no need to describe all the characteristics of the link. Only the following properties are required:


LinkedKey	Item of linked data file used in the link.
SourceKey	Item of source data file used in the link.
LinkedFile	Name of linked data file used in the link.
SourceFile	Name of source data file used in the link.
Name	Name of the link.

Component : wd250hf.dll