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

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.

mpiPropertyGetPropertiesXML

The C API uses different interface methods, including mpiPropertyGetPropertiesXML.

MPIRC mpiPropertyGetPropertiesXML (HMPIOBJ  hObject,  int pIDs[],  int iOffset, 
int iCount,  char *pszOutXML,  size_t *pnLen);

Inputs

hObject: Object for which the properties are being requested.
pIDs: Integer array which lists the property IDs that are to be returned. For indexed type properties all index values are returned.
ioffset: Start offset in the array of property IDs.
iCount: Number of elements of the property ID array to use.
pnLen: Size of the buffer passed in pszOutXML.

Outputs

pszOutXML: Returned XML document conforming to dtxpi_properties.xsd, which contains the values of the requested properties.
pnLen: Size of the XML document returned.

Returns

Success status