Home
Runtimes
Descriptions of Link runtime services.
SDK
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.
Object methods
C API card object methods overview
The following methods are supported by the C API card object.
mpiCardGetMapObject
The C API uses different card object methods, including mpiCardGetMapObject.

Runtimes
Descriptions of Link runtime services.
- REST API
  The REST Runtme provides a REST API used to run maps and flows that have been deployed.
- Flow Command Server
  Deploy a flow from the HCL Link to the local filesystem using Execution flow server definition.
- Map Command Server
  To use the Map Command Server to execute a map, you will prepare the maps for execution.
- SDK
  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
      - C API map object methods overview
        The following methods are supported by the C API map object.
      - C API card object methods overview
        The following methods are supported by the C API card object.
        mpiCardGetAdapterObject
        The C API uses different card object methods, including mpiCardGetAdapterObject.
        mpiCardGetAdapterType
        The C API uses different card object methods, including mpiCardGetAdapterType.
        mpiCardGetMapObject
        The C API uses different card object methods, including mpiCardGetMapObject.
        mpiCardOverrideAdapter
        The C API uses different card object methods, including mpiCardOverrideAdapter.
      - Adapter object methods
        The following methods are supported by the adapter objects.
    - 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.
    - 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.

mpiCardGetMapObject

The C API uses different card object methods, including mpiCardGetMapObject.

MPIRC mpiCardGetMapObject (HMPICARD  hCard,HMPIMAP  *hMap)

Inputs

hCard: Card object

Outputs

hmap: Map object

Returns

Success status