Skip to content

XML Functions

🛠️ Tools · ⬅ Top


This is a work in progress and may change. (2025-09-29)

__xmlHeader

Prints the <?xml header for XML files

Usage

__xmlHeader

Prints the <?xml header for XML files

Writes to standard output

String. XML header

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

__xmlTag

Output am XML single tag

Usage

__xmlTag name [ ... ]

Output am XML single tag

Writes to standard output

String. XML single tag

Arguments

  • name - String. Required. Tag name.
  • ... - Arguments. Optional. Attributes to output within the tag in name/value pairs as name=value

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

__xmlTagOpen

Output am XML open tag

Usage

__xmlTagOpen name [ ... ]

Output am XML open tag

Writes to standard output

String. XML tag open

Arguments

  • name - String. Required. Tag name.
  • ... - Arguments. Optional. Attributes to output within the tag in name/value pairs as name=value

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

__xmlTagClose

Output am XML close tag

Usage

__xmlTagClose name

Output am XML close tag

Writes to standard output

String. XML tag close

Arguments

  • name - String. Required. Tag name.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

__xmlAttributeValue

Output an XML attribute value with proper quoting

Usage

__xmlAttributeValue [ value ]

Output an XML attribute value with proper quoting

Writes to standard output

String. XML attribute value

Arguments

  • value - EmptyString. Optional.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

__xmlAttributes

Output XML attributes

Usage

__xmlAttributes [ nameValue ]

Output XML attributes Beware of Bash quoting rules when passing in values

Writes to standard output

String. XML attribute values formatted on a single line with a leading space

Arguments

  • nameValue - String. Optional. One or more name/value pairs in the form name=value where the delimiter is an equals sign = and the value is unquoted.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error