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 function overview
Use the Link programming interface to load, run and control maps.
Load and run map overview
Use the loading and running methods to load specific maps, refresh maps when the maps have changed, and run maps.
Refresh
This method updates a map instance with a new map definition following an invocation of Reload.

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 function overview
    Use the Link programming interface to load, run and control maps.
    - Scenario: running Link programming interface maps
      Code examples of running maps are installed with the Development Kit in the install_dir\examples\dk\dtxpi directory, where install_dir represents the directory in which the DK is installed.
    - Monitor and manage map overview
      These methods enable the execution of a map to be controlled from another thread, and for the progress of a map to be reported.
    - Load and run map overview
      Use the loading and running methods to load specific maps, refresh maps when the maps have changed, and run maps.
      - LoadFile
        This method reads the compiled map file (.mmc) if it has not previously been read.
      - LoadMemory
        This method processes the map code (CompiledMap) if it has not been previously processed. LoadMemory then creates and populates the hierarchy of map, card, and adapter objects.
      - Refresh
        This method updates a map instance with a new map definition following an invocation of Reload.
      - ReloadFile
        This method instructs the engine to read the compile map file specified by MapName and to update its internal map cache.
      - ReloadMemory
        This method instructs the Link programming interface to process the compiled map (CompiledMap) and to update its internal map cache.
      - Run
        This method executes the map defined by the map object.
      - Unload
        This method destroys the map object, and other card and adapter objects associated with it.
- 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.

Refresh

This method updates a map instance with a new map definition following an invocation of Reload.

If a compiled map changes during the execution of a process, the changed map will not be picked up by the Link programming interface unless an explicit call to Refresh is made.

It is recommended that you not add or remove cards while there are existing map objects referencing the map. This could lead to unpredictable behavior. If such changes are made, all map instances referencing the map must be terminated (by invoking Unload). If the only changes to maps are to the map rules, it is valid to call Reload and Refresh to pick up the changes to the map.