The pFormat Argument

The pFormat argument for GetValueAt() is an optional string that controls the format of the returned string. This string can contain any suitable combination of the characters in the following table:

General Description	Character to Include in Format Setting	Specific Behavior
Line feeds and carriage returns	w	Adds a Windows-style carriage return and line feed combination after every text-free element.
Line feeds and carriage returns	r	Uses the stored line feeds and carriage returns. This option takes precedence over the options w and n.
Line feeds and carriage returns	n	Includes a new line (line feed) after every text-free element. In contrast to w, this option does not add a carriage return.
Indentation. Note that these options are used only if the output includes new lines.	i	Indents each new line with four spaces.
Indentation	Any integer from 1 to 9	Indents each new line with this number of spaces. This option takes precedence over the previous indentation option.
Indentation	t	Indents each new line with a tab. This option takes precedence over both of the previous indentation options.
Indentation	s	Uses the stored indentation whitespace. This option takes precedence over the previous indentation options.
Handling attributes	a	Alphabetizes the attributes in an element.
Handling attributes	q	Uses double quotes (rather than single quotes) to set off attribute values if possible.
Handling namespaces	p	Suppresses output of namespace prefixes.
Handling namespaces	x	Suppresses output of namespace declarations.
Handling empty elements	e	Generates output for each empty element with an open tag and close tag pair. If this option is not set, empty elements are output as a single empty tag. This option takes precedence over option g.
Handling empty elements	g	Suppresses output of empty tags.
Other	c	Canonical output. This option takes precedence over the options e i n t w.
Other	f	Generates the full element (including both the starting and ending tags), not just the contents within the element.
Other	l	Includes information about the location of the schema file that was loaded into InterSystems IRIS. This option takes effect only if you use f.
Other	o	Includes any XML entities as is, rather than performing XML escaping for those entities.
Other	C(e)	Generates an XML header line that declares the given character encoding; e is the non-quoted name of a character encoding such as UTF–8. If e is empty, use the encoding defined by the adapter. If e begins with ! then force the encoding of the output stream. Note that this will be applied automatically for file operations configured with a non-UTF-8 character set.

As noted above, the pFormat argument can equal a combination of these items. For example, if you use the value C(UTF-8)q, the outbound document is in the UTF-8 character set and attributes are set off with double quotes. For another example, if you use the value C(UTF-16)a, the outbound document is in the UTF-16 character set and attributes are alphabetized.

Note:

This information also applies to the Format setting of an XML business operation.