GetLinks Method

Gets a Links collection.

See Also

Signature

RetVal = object.GetLinks([LinkTemplate] [, ObjectIDs] [, LinkTypes] [, Document])

Object

DbConnect
The object or objects this method applies to.

LinkTemplate

LinkTemplate object, or a string identifying a link template; input-only; optional
If specified, indicates the link template whose links are returned.

ObjectIDs

Variant (array of Longs); input-only; optional
If specified, each long is the object ID of an AutoCAD entity whose links are to be returned.

LinkTypes

Variant; input-only; optional
Specifies the type of links to return. Any combination of the following link types can be specified:

• kEntityLinkType returns entity links.
• kFSLabelType returns freestanding labels.
• kAttachedLabelType returns 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 neither a LinkTemplate or a Document argument is specified, the document object is identified as follows:

• If the LinkTemplate argument is a string naming a link template, the current document is used.
• If the LinkTemplate argument is a LinkTemplate object, the link template document is used.
• If no LinkTemplate argument is supplied, the current document is used.

RetVal

Links collection;
The Links collection for the specified link template.

Remarks

If no arguments are specified, GetLinks returns all entity links associated with the current document.