xmlEncodedXML

Defines the type for XML and HTML documents.

This type is used to pass large XML and HTML documents to IBM® Cognos® Analytics components through the API. Characters that are reserved in XML and HTML, such as less-than (<) and greater-than (>), must be encoded or the operation may fail.

You can encode reserved characters by replacing them with the corresponding character entities, or by substituting the corresponding Unicode numeric representation.

To encode reserved characters using character entities, perform the following text substitutions on the document.

Table 1. Encoding reserved characters

Search Text

Replacement Text

&

&amp;

<

&lt;

>

&gt;

"

&quot;

'

&apos;

The substitution of & must be performed first.

To decode the document, perform the substitutions in reverse, replacing &amp; with & last.

Note: This encoding and decoding applies to the raw Simple Object Access Protocol (SOAP) interface. If you are using a toolkit that performs these substitutions for you, do not explicitly encode or decode XML strings in your application.

This class

  • inherits properties from the string

Derived Classes

References

Used by the following properties:
Used by the following method parameters:
Used by the following method return values: