GetLinksByKey [Connectivity Automation Reference: CAR]

GetLinksByKey Method


Gets a Links collection based on link template, link key values, and (optionally) link type.

See Also

Signature

RetVal = object.GetLinksByKey(LinkTemplate, KeyValues [, LinkTypes] [, Document])

Object

DbConnect
The object or objects this method applies to.

LinkTemplate

LinkTemplate object, or a string identifying a link template; input-only
Specifies the link template whose links are returned.

KeyValues

KeyValues collection; input-only
The KeyValues collection containing the key values to search for.

LinkTypes

Integer; input-only; optional
Specifies the type of links to return. You can specify any combination of the following link types:

kEntityLinkType: Entity links

kFSLabelType: Freestanding labels

kAttachedLabelType: Attached labels

If no value is specified, only entity links are returned.

Document

Document object; input-only; optional
This argument is ignored if a LinkTemplate object is passed as the first argument. If this argument is not specified, the document object is identified as follows:

RetVal

Links collection
The Links collection for the specified keys.