Home
LNK APIs
The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
C API
The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
Loading, running, and controlling maps
There are various methods you can use to load, run, and control maps when you use APIs with HCL Link.
C API examples
The examples included with the C API are located in the following directory: install_dir\examples\dk\dtxpi\c

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.
- C API
  The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
  - C API interface methods overview
    The map, card, and adapter object properties define the properties that can be set for each object. Use the C API interface methods to GET or SET the adapter object properties.
  - Object methods
  - Loading, running, and controlling maps
    There are various methods you can use to load, run, and control maps when you use APIs with HCL Link.
    - Loading and running maps
      Use the following methods to load specific maps, refresh maps when the maps have changed, and run maps.
    - Controlling and monitoring maps
      These methods allow map execution to be controlled from another thread and to report map progress.
    - Initialization and termination methods
      The following methods initialize the environment required for running maps and clean up the environment after the map run is complete.
    - Callbacks
      An API application uses callback to receive logging messages on a per-map basis or for global logging based on HCL Link initialization.
    - C API examples
      The examples included with the C API are located in the following directory: install_dir\examples\dk\dtxpi\c
      - Running a single map
        This example shows the simplest way to load and run a map. After the map is loaded, it can be run any number of times.
      - Running multiple instances of a map in parallel
        This example shows how to create multiple instances of map objects and how to run these map instances in parallel.
      - Overriding a card in a map
        This example shows how to set properties of card objects to override the settings of the compiled map.
      - Using a user-provided status method
        This example shows how to provide a status method to the C API and how to receive notification of the progress of a map execution.
      - Using streams to override inputs and outputs
        This example shows how to pass data to an input card of a map and how to get data from an output card of a map (the sending of a single buffer to the API).
      - Loading a map from a byte array
        This example shows how to load a map from a byte array.
      - Getting and setting properties
        This example shows how to GET and SET properties.
      - Developing a custom adapter
        To develop a custom adapter, please see the filesamp.c example, which demonstrates all of the interfaces that are described in this documentation. The example is well-commented and should be consulted to aid in the understanding of the adapter interface.
  - Custom adapters
    The custom adapters interface makes it possible for users to develop adapters with as much functionality as those provided with the product.
- 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.

C API examples

The examples included with the C API are located in the following directory: install_dir\examples\dk\dtxpi\c