xml-helper documentation

Objective

The objective of this component is to give the programmer the possibility of listing all the elements, it's attributes, it's parent elements and it's values of a XML text or a XML File.

Functionalities

• Load the XML Text

  Loads the XML text into the component.

  Parameters:

  Parameter Name	Parameter Type	Data Type	Is Mandatory?
  XmlText	Input Parameter	Text	[x]
  HasError	Output Parameter	Boolean
  Error	Output Parameter	Error

• Load the XML File

  Loads the XML File into the component.

  Parameters:

  Parameter Name	Parameter Type	Data Type	Is Mandatory?
  XmlFile	Input Parameter	Binary Data	[x]
  HasError	Output Parameter	Boolean
  Error	Output Parameter	Error

• List all elements in the XML

  List all the element in the XML that was loaded to the component.

  The element object properties will be explained below.

  Parameters:

  Parameter Name	Parameter Type	Data Type	Is Mandatory?
  HasError	Output Parameter	Boolean
  Error	Output Parameter	Error
  ElementsList	Output Parameter	List of Element

• Search for a Element

  Search for a element by it's Name, it's Namespace or it's Parent Element Name.

  Note that the search is case sensitive

  Parameters:

  Parameter Name	Parameter Type	Data Type	Is Mandatory?
  ParentName	Input Parameter	Text
  Name	Input Parameter	Text
  Namespace	Input Parameter	Text
  HasError	Output Parameter	Boolean
  Error	Output Parameter	Error
  ElementsList	Output Parameter	List of Element

• Search for a Value

  Search for a specific value in the values of the element.

  Note that the search is case sensitive

  Parameters:

  Parameter Name	Parameter Type	Data Type	Is Mandatory?
  TextValue	Input Parameter	Text	[x]
  HasError	Output Parameter	Boolean
  Error	Output Parameter	Error
  ElementsList	Output Parameter	List of Element

Objects Returned

Element

Object Definition

Attributes

Object Definition

Error

Object Definition