For the complete documentation index, see llms.txt. This page is also available as Markdown.

xml

This type represents an XML Object in BoxLang

Xml Methods

bxDump(label=[string], top=[numeric], expand=[boolean], abort=[boolean], output=[string], format=[string], showUDFs=[boolean])

Outputs the contents of a variable (simple or complex) of any type for debugging purposes to a specific output location.

, The available ,,output,, locations are: - ,,buffer,,: The output is written to the buffer, which is the default location. If running on a web server, the output is written to the browser. - ,,console,,: The output is printed to the System console. - ,,Absolute File Path,, The output is written to a file with the specified absolute file path. ,

,

The output format can be either HTML or plain text.

The default format is HTML if the output location is the buffer or a web server or a file, otherwise it is plain text for the console.

Arguments:

Argument
Type
Required
Default

label

string

false

null

top

numeric

false

null

expand

boolean

false

true

abort

boolean

false

false

output

string

false

null

format

string

false

null

showUDFs

boolean

false

true

childPos(childname=[string], n=[integer])

Gets the position of a child element within an XML document object.

The position, in an XmlChildren array, of the Nth child that has the specified name.

Arguments:

Argument
Type
Required
Default

childname

string

true

null

n

integer

true

null

clone()

Clone this XML object

getNodeType()

Get XML values according to given xPath query

keyExists(key=[any])

Tests whether a key exists in a struct and returns a boolean value

Arguments:

Argument
Type
Required
Default

key

any

true

null

search(xpath=[String], params=[Struct])

Get XML values according to given xPath query

Arguments:

Argument
Type
Required
Default

xpath

String

true

null

params

Struct

false

{}

transform(XSL=[String], parameters=[Struct])

Get XML values according to given xPath query

Arguments:

Argument
Type
Required
Default

XSL

String

true

null

parameters

Struct

false

{}

Examples

Last updated

Was this helpful?