GetLinksByKey Method (ActiveX/CAO)

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

Signature

VBA / VB.NET 

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

Type: DbConnect

The object or objects this method applies to.

LinkTemplate

Type: LinkTemplate, or String identifying a link template; input-only

Specifies the link template whose links are returned.

KeyValues

Type: KeyValues; input-only

The KeyValues collection containing the key values to search for.

LinkTypes

Type: Integer; input-only; optional

Specifies the type of links to return. You can specify any combination of the following link types:

  • kFSLabelType: Freestanding labels
  • kAttachedLabelType: Attached labels

If no value is specified, all label links are returned.

Document

Type: AcadDocument; input-only; optional

This argument is ignored if a LabelTemplate object is passed as the first argument. If this argument is not specified, the document object is identified as follows:

  • If the LabelTemplate argument is a string naming a label template, the current document is used.
  • If the LabelTemplate argument is a LabelTemplate object, the label template document is used.
RetVal

Type: Links

The Links collection for the specified keys.

Related Reference