Home
LNK APIs
The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
Link programming interface overview
The Link programming interface is an object-oriented approach that enables applications to invoke HCL Link maps, thus removing reliance on command lines.
Link programming interface object overview
The Link programming interface is based on map, card, adapter, connection, and stream objects.
Card object overview
The card object is an abstraction of a card in a map.
Card object methods
The card object methods are defined by the card object.

LNK APIs
The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
- Link programming interface overview
  The Link programming interface is an object-oriented approach that enables applications to invoke HCL Link maps, thus removing reliance on command lines.
  - Link programming interface methods
    The Link programming interface map, card, and adapter object properties define the properties that can be set for each object. Use these methods to GET or SET the object properties.
  - Link programming interface object overview
    The Link programming interface is based on map, card, adapter, connection, and stream objects.
    - Link programming interface object hierarchy
      The Link programming interface objects have a relationship to each other defined by a specific hierarchy.
    - Link programming interface properties
      The Link programming interface methods provide a means to query or modify properties of objects.
    - Link programming interface map object
      The Link programming interface creates a map object instance from the byte array representing a compiled map file. The hierarchies of map, card and adapter objects are created by this method.
    - Card object overview
      The card object is an abstraction of a card in a map.
      - Card object properties
        Properties can be set and their values can be obtained by executing the methods defined by the card object.
      - Card object methods
        The card object methods are defined by the card object.
        CardGetAdapterObject
        This method returns the adapter object associated with the specified card object.
        CardGetAdapterType
        This method returns the type of the adapter object that is currently associated with the specified card object.
        CardGetMapObject
        This method returns the map object associated with the specified card object.
        CardOnNotify
        This method can be called to provide a notification for adapters of key events.
        CardOverrideAdapter
        This method can be called to associate a new adapter object with the card object. This is used whenever the type of the adapter needs to be changed programmatically from the type that is compiled into the map.
    - Adapter object overview
      An adapter object is created for each card when a map instance object is created.
  - Link programming interface function overview
    Use the Link programming interface to load, run and control maps.
- C API
  The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
- Python API
  Use the Python API to create, edit, and run maps and schemas from a Python program. For details, see the documentation installed in install_dir/python/api/hip/docs/html/index.html. Examples of the Python API are installed in install_dir/python/api/examples. Documentation for the Python API examples is available in install_dir/python/api/docs/html/examples.html.
- Java API
  The Java API interfaces enable you to create, edit, and run maps and schemas from a Java™ program.
- Java Tools
  The Java™ Tools provide objects and JNI utilities that you can use to get information about your map instances.

Card object methods

The card object methods are defined by the card object.

The card object provides several methods.