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.
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.
mpiPropertySetPropertiesXML
The C API uses different interface methods, including mpiPropertySetPropertiesXML.

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.
      - mpiPropertyGetBinary
        The C API uses different interface methods, including mpiPropertyGetBinary.
      - mpiPropertyGetCount
        The C API uses different interface methods, including mpiPropertyGetCount.
      - mpiPropertyGetInteger
        The C API uses different interface methods, including mpiPropertyGetInteger.
      - mpiPropertyGetPtr
        The C API uses different interface methods, including mpiPropertyGetPtr.
      - mpiPropertyGetText
        The C API uses different interface methods, including mpiPropertyGetText.
      - mpiPropertySetBinary
        The C API uses different interface methods, including mpiPropertySetBinary.
      - mpiPropertySetInteger
        The C API uses different interface methods, including mpiPropertySetInteger.
      - mpiPropertySetPtr
        The C API uses different interface methods, including mpiPropertySetPtr.
      - mpiPropertySetText
        The C API uses different interface methods, including mpiPropertySetText.
      - mpiPropertyGetAllPropertiesXML
        The C API uses different interface methods, including mpiPropertyGetAllPropertiesXML.
      - mpiPropertyGetPropertiesXML
        The C API uses different interface methods, including mpiPropertyGetPropertiesXML.
      - mpiPropertySetPropertiesXML
        The C API uses different interface methods, including mpiPropertySetPropertiesXML.
    - 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.
    - 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.

mpiPropertySetPropertiesXML

The C API uses different interface methods, including mpiPropertySetPropertiesXML.

MPIRC mpiPropertySetPropertiesXML (HMPIOBJ hObject,  const char *pszInXML)

Inputs

hObject

Object for which the properties are set.

pszInXML

XML document conforming to dtxpi_properties.xsd which lists the properties that are to be set. It is possible to set properties on an object and on its related objects in a single call. Specifically,

If called on a adapter object, only adapter properties can be set.
If called on an card object, then the properties of the card and its related adapter object can be set
If called on an map object, then the properties of the map and its related card and adapter objects can be set.

Outputs

None

Returns

Success status.