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 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.
GetPropertiesXML
Retrieves requested property values as an XML document. Properties are specified in the form of an XML document.

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.
    - GetAllPropertiesXML
      Retrieves all object properties in XML document.
    - GetBinaryProperty
      This method gets a pointer to the specified binary property of the object. The data is not copied by this method.
    - GetCountProperty
      This method returns the number of defined property values.
    - GetIntegerProperty
      This method gets the specified integral property of the object.
    - GetTextProperty
      This method gets a pointer to the specified text property of the object. The data is not copied by this method.
    - GetPropertiesXML
      Retrieves requested property values as an XML document. Properties are specified in the form of an XML document.
    - SetBinaryProperty
      This method sets the specified binary property on the object.
    - SetIntegerProperty
      This method sets the specified integral property on the object.
    - SetTextProperty
      This method sets the specified text property on the object.
    - SetPropertiesXML
      Sets properties specified in XML document. Properties are specified in the form of an XML document.
  - 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.
- 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.

GetPropertiesXML

Retrieves requested property values as an XML document. Properties are specified in the form of an XML document.

The XML schema for this XML document is txpi_properties.xsd located in the installation directory. Both the request document, which specifies which properties to return, and the returned document comply to this XML schema.