ParseXml (HttpResponse function) - Revision history

ELowell: /* Syntax terms */

2015-09-03T17:33:02Z

Syntax terms

← Older revision		Revision as of 17:33, 3 September 2015
Line 11:		Line 11:
	</td></tr>		</td></tr>

	<tr><th nowrap>%httpResponse</th>		<tr><th nowrap>httpResponse</th>
	<td>A reference to an <var>[[HttpResponse_class\|HttpResponse]]</var> object that was returned by a <var>Get</var>, <var>Post</var>, or <var>Send</var> method of an <var>HttpRequest</var> object.</td></tr>		<td>A reference to an <var>[[HttpResponse_class\|HttpResponse]]</var> object that was returned by a <var>Get</var>, <var>Post</var>, or <var>Send</var> method of an <var>HttpRequest</var> object.</td></tr>

ELowell: /* Syntax terms */

2015-09-03T16:57:30Z

Syntax terms

← Older revision		Revision as of 16:57, 3 September 2015
Line 11:		Line 11:
	</td></tr>		</td></tr>

	<tr><th>%httpResponse</th>		<tr><th nowrap>%httpResponse</th>
	<td>A reference to an <var>[[HttpResponse_class\|HttpResponse]]</var> object that was returned by a <var>Get</var>, <var>Post</var>, or <var>Send</var> method of an <var>HttpRequest</var> object.</td></tr>		<td>A reference to an <var>[[HttpResponse_class\|HttpResponse]]</var> object that was returned by a <var>Get</var>, <var>Post</var>, or <var>Send</var> method of an <var>HttpRequest</var> object.</td></tr>

JAL: /* Usage notes */

2014-03-18T17:59:22Z

Usage notes

← Older revision		Revision as of 17:59, 18 March 2014
Line 74:		Line 74:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li><var>ParseXml</var> is equivalent to, but faster than, issuing the <var class="product">Janus SOAP</var> XML text-conversion method <var>LoadXml</var> against the <var>Longstring</var> returned by <var>[[Content (HttpResponse function)\|Content]]</var>.		<li><var>ParseXml</var> is equivalent to, but faster than, issuing the <var class="product">Janus SOAP</var> XML text-conversion method <var>[[LoadXml (XmlDoc/XmlNode function)\|LoadXml]]</var> against the <var>Longstring</var> returned by <var>[[Content (HttpResponse function)\|Content]]</var>.

	<li>If the content type header indicates HTML, XML, or plain text, ASCII-to-EBCDIC translation is performed. If the <var>Clsock</var> port definition specifies a translation table for ASCII-to-EBCDIC, that table is used instead of the default.		<li>If the content type header indicates HTML, XML, or plain text, ASCII-to-EBCDIC translation is performed. If the <var>Clsock</var> port definition specifies a translation table for ASCII-to-EBCDIC, that table is used instead of the default.

JAL: /* See also */

2014-03-13T20:32:19Z

JAL at 18:26, 11 March 2014

2014-03-11T18:26:27Z

← Older revision		Revision as of 18:26, 11 March 2014
Line 22:		Line 22:
	<ul>		<ul>
	<li><b>AllowUntranslatable</b><br>		<li><b>AllowUntranslatable</b><br>
	Allows all valid Unicode strings into the XML document. When this option is not specified, Unicode strings that are not translatable to EBCDIC are not allowed. As described in [[##Deserializing Unicode strings\|"Deserializing Unicode strings"]], it is recommended that you use <var>AllowUntranslatable</var> only if the application checks for translatability when accessing parts of the <var>XmlDoc</var> that may have untranslatable Unicode content.		Allows all valid Unicode strings into the XML document. When this option is not specified, Unicode strings that are not translatable to EBCDIC are not allowed. As described in [[##Deserializing Unicode strings\|Deserializing Unicode strings]], it is recommended that you use <var>AllowUntranslatable</var> only if the application checks for translatability when accessing parts of the <var>XmlDoc</var> that may have untranslatable Unicode content.
	<p>The <var>AllowUntranslatable</var> option is available as of <var class="product">[[Sirius Mods]]</var> Version 7.6.</p>		<p>The <var>AllowUntranslatable</var> option is available as of <var class="product">[[Sirius Mods]]</var> Version 7.6.</p>

JAL at 19:58, 10 March 2014

2014-03-10T19:58:59Z

New page

{{Template:HttpResponse:ParseXml subtitle}}
The <var>ParseXml</var> method helps you access the document/content from <var>[[HttpRequest_class|HttpRequest]]</var> <var>[[Get (HttpRequest function)|Get]]</var>, <var>[[Post (HttpRequest function)|Post]]</var>, and <var>[[Send (HttpRequest function)|Send]]</var> operations. <var>ParseXml</var> deserializes returned XML data into the <var class="product">[[Janus SOAP]]</var> <var>[[XmlDoc_class#The_XmlDoc_class|XmlDoc]]</var> object you specify.

==Syntax==
{{Template:HttpResponse:ParseXml syntax}}

===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th>
<td>A numeric variable. Successful deserialization returns 0; failure returns a non-zero value.
</td></tr>

<tr><th>%httpResponse</th>
<td>A reference to an <var>[[HttpResponse_class|HttpResponse]]</var> object that was returned by a <var>Get</var>, <var>Post</var>, or <var>Send</var> method of an <var>HttpRequest</var> object.</td></tr>

<tr><th>doc</th>
<td>A previously instantiated <var>XmlDoc</var> object which must be <var>[[XmlDoc API#XmlDoc states|EMPTY]]</var>.
</td></tr>

<tr><th>options</th>
<td>Any valid combination of the following (which are the same as the options of the <var>[[LoadXml_(XmlDoc/XmlNode_function)|LoadXML]]</var> method):
<ul>
<li>AllowUntranslatable 
Allows all valid Unicode strings into the XML document. When this option is not specified, Unicode strings that are not translatable to EBCDIC are not allowed. As described in [[##Deserializing Unicode strings|"Deserializing Unicode strings"]], it is recommended that you use <var>AllowUntranslatable</var> only if the application checks for translatability when accessing parts of the <var>XmlDoc</var> that may have untranslatable Unicode content.
The <var>AllowUntranslatable</var> option is available as of <var class="product">[[Sirius Mods]]</var> Version 7.6.

<li>CrPreserve 
All whitespace characters in Element content are preserved, including carriage return. Unlike all other deserialization options, a carriage return in Element content does ''not'' undergo the normalization specified in the XML standard (and described in [[XML processing in Janus SOAP#Normalizing whitespace characters|"Normalizing whitespace characters"]]). <var>CrPreserve</var> is mutually exclusive with the <var>WspNewline</var>, <var>WspToken</var>, and <var>WspPreserve</var> options, and with the <var>LinefeedNoTrailingTabs</var> option.
The <var>CrPreserve</var> option was added in <var class="product">Sirius Mods</var> Version 7.5, as well as implemented with a maintenance zap <var class="product">Sirius Mods</var> Version 7.4.

<li>DTDIgnore 
A “<!DOCTYPE ...>” clause may be present in the document, and it should be ignored. In any case, the DTD is not processed. The default behavior, that is, if <var>DTDIgnore</var> is not present, is to treat “<!DOCTYPE ...>” as a syntax error.
<var>DTD_Ignore</var> is a synonym for <var>DTDIgnore</var>.

<li>ErrRet 
Errors during deserialization are tolerated, the method object is not updated (retains its pre-call state), and the request continues. If <var>ErrRet</var> is not present, any error will cancel the request. Note that some errors still cancel the request; errors tolerated when <var>ErrRet</var> is specified are:
<ul>
<li>A syntax error in the text string representation of the XML document
</ul>

<li>HtmlCharEnt 
Allow the standard XHTML entities for element and attribute content, and convert them to the corresponding Unicode characters. You can find the list of XHTML entities on the Internet at http://www.w3.org/TR/xhtml1/dtds.html#h-A2.

<li>LinefeedNoTrailingTabs 
For a Text node that consists of an initial line-end character and one or more tab characters, this option normalizes the content so the result is a single line-end character. The initial line-end (also called "newline") character can be a linefeed character (LF) or a carriage-return (CR) by itself, or a carriage-return followed by a linefeed (CRLF), since (within Text nodes) all of these are normalized by the XML specification into a single line-end character.

This option is compatible with, but takes precedence over, any of the other whitespace-handling options (<var>WspNewline</var>, <var>WspToken</var>, <var>WspPreserve</var>) except <var>CrPreserve</var>.

See [[#Whitespace handling|Whitespace handling]], below, for more information about this option and about whitespace handling.

<li>ReplaceUnicode 
Converts Unicode characters using the replacements (if any) specified at your site by <var>[[Unicode#The UNICODE command|UNICODE]]</var> updating commands that use the <var>Rep</var> subcommand (for example, <code>UNICODE Table Standard Rep U=2122 '(TM)'</code>).

The replacement is performed on all names, element and attribute values, comments, and PI "values" in the document, after any entity and character references have been converted to characters.

For further discussion and examples, see the <var>ReplaceUnicode</var> discussion in [[#Usage Notes|Usage Notes]], below.

<li>WspNewline 
This option is designed to remove any whitespace inserted to make the structure of an XML document easier (for a person) to read. <var>WspNewline</var> removes the leading or trailing whitespace in the value of a Text node, if the whitespace sequence contains a newline (carriage return or linefeed) character.
'''Note:''' This handling, the default whitespace option for this method, applies to the "physical value" of the representation of a Text node. In particular, markup such as a character reference (even of whitespace, for example, <code>&#32;</code>), a CDATA section, or any non-whitespace character delimits leading or trailing whitespace and is not affected.

See [[#Whitespace handling|Whitespace handling]], below, for more information about whitespace handling.

<li>WspPreserve 
All whitespace characters in element content are preserved (after end-of-line normalization), as described below in [[#Whitespace handling|Whitespace handling]].
'''Note:''' <var>Wsp_Preserve</var> is a synonym for <var>WspPreserve</var>.

<li>WspToken 
Whitespace in element content is normalized using the XPath <code>normalize()</code> function (leading and trailing whitespace removed, intermediate strings of whitespace replaced by a single blank character). <var>WspToken</var> is a good substitute for <var>WspNewline</var> to remove leading and trailing whitespace in cases where blanks (or tabs) and not line-end characters were used to make the document structure more readable — if it is tolerable to collapse intermediate whitespace sequences to single space characters.

See [[#Whitespace handling|Whitespace handling]] for more information about whitespace handling.</ul>
</td></tr></table>

==Usage notes==
<ul>
<li><var>ParseXml</var> is equivalent to, but faster than, issuing the <var class="product">Janus SOAP</var> XML text-conversion method <var>LoadXml</var> against the <var>Longstring</var> returned by <var>[[Content (HttpResponse function)|Content]]</var>.

<li>If the content type header indicates HTML, XML, or plain text, ASCII-to-EBCDIC translation is performed. If the <var>Clsock</var> port definition specifies a translation table for ASCII-to-EBCDIC, that table is used instead of the default.

<li>None of the ''options'' may be specified twice.

<li>The ''options'' may be specified in any case. For example, you can use <code>WspPreserve</code> and <code>wsppreserve</code>, interchangeably.
</ul>

===Whitespace handling===
<ul>
<li>The "Wsp" whitespace-handling ''options'' (<var>WspPreserve</var>, <var>WspNewline</var>, and <var>WspToken</var>) and the <var>CrPreserve</var> whitespace option are mutually exclusive; if none of them is specified, <var>WspNewline</var> is in effect. Although the <var>LinefeedNoTrailingTabs</var> option is also concerned with whitespace, it is distinct from, yet compatible with, any of the three “Wsp” options, but it is not compatible with the <var>CrPreserve</var> option.

<li>Except for <var>CrPreserve</var>, the whitespace-handling ''options'' are applied after the XML standard whitespace conversions that <var class="product">Janus SOAP</var> always applies. As described in [[XML processing in Janus SOAP#Normalizing whitespace characters|Normalizing whitespace characters]], the standard specifies that '''all''' carriage return/linefeed sequences and carriage return sequences are to be converted to linefeeds when deserializing. Using the CrPreserve option bypasses this rule.

<li>The whitespace-handling ''options'' do '''no''' whitespace conversion (beyond the XML standard conversions) on element content that is "protected" by the <code>xml:space="preserve"</code> attribute.

"Protected" by the xml:space="preserve" attribute means an element E that either:
<ul>
<li>Has the <code>xml:space</code> attribute with the value <code>preserve</code>
<li>Is contained in an element A with that attribute and value, and there is no element that is a descendent of A and an ancestor of E with the <code>xml:space</code> attribute with the value <code>default</code>
</ul>

Elements that are not protected by the <code>xml:space="preserve"</code> attribute have whitespace handled according to the option in effect for the deserialization.

<li>Using <var>WspNewline</var> or <var>WspToken</var> reduces the space consumed by individual Text nodes, and in some cases collapses all whitespace content between markup to the null string, so it is not stored as a <var>Text</var> node. This reduces the storage required by the <var>XmlDoc</var>, speeds up XPath and node access processing, and makes the output of the <var>[[Print (HttpResponse subroutine)|Print]]</var> subroutine easier to read.

<li>The <var>LinefeedNoTrailingTabs</var> option only affects Text nodes that contain an initial line-end character followed by any number of tabs and nothing else. The <var>LinefeedNoTrailingTabs</var> effect on such a Text node, whether it is specified with or without any of the "Wsp" options, is to store the value of the node as a single line-end character.

One example of the use of the <var>LinefeedNoTrailingTabs</var> option is an input XML document to be deserialized for which both of the following are true:
<ul>
<li>A digital signature is needed of a subtree in the document.
<li>The input subtree contains a linefeed and one or more tabs that separate markup, and the linefeed must be kept but the tabs discarded for the signature.
</ul>

For information about exclusive canonicalization, serialization expressly designed for digital signatures, see [[XmlDoc API serialization options#Canonicalization|Canonicalization]].
</ul>

===Deserializing Unicode strings===
The <var>ParseXml</var> <var>AllowUntranslatable</var> option lets you deserialize Unicode strings that contain characters that are not translatable to EBCDIC. Otherwise, such characters in an input XML document are detected, an <var>XmlParseError</var> exception with reason <code>UntranslatableUnicode</code> is thrown, and the request is canceled.

This default detection of non-translatable characters may suit your purposes. That is, it ensures that subsequent access to the deserialized content is performed without any Unicode to EBCDIC translation errors. For example:
 %doc:ParseXml
...
%val Longstring
%val = %doc:Value(%xpath)


The assignment to the EBCDIC string <code>%val</code> will not fail due to a Unicode translation problem: if there is any untranslatable Unicode (including, of course, strings in the XML document which your application never accesses), the <var>ParseXml</var> operation fails.

If you use <var>AllowUntranslatable</var>, all Unicode characters in a serialized input XML document are allowed and stored in the <var>XmlDoc</var>. Your stored data may contain content that is not translatable to
EBCDIC, however. A subsequent attempt to access such content that performs Unicode to EBCDIC translation might cause request cancellation. You should therefore use <var>AllowUntranslatable</var> only if there is also a check for translatability when parts of the <var>XmlDoc</var> that may have non-translatable Unicode content are accessed.

The code below shows a way to get the benefit of specifying <var>AllowUntranslatable</var> while limiting the risk of request cancellation. In the example, it is believed that only the element <code>comments</code> might contain untranslatable Unicode among all the data accessed from the XML document:
 %resp:ParseXml(%doc, 'AllowUntranslatable')
...
%uVal Unicode
%val Longstring
%uVal = %node:Value('comments')
Try %val = %uVal:UnicodeToEbcdic
Catch CharacterTranslationException
%val = %uVal:UnicodeToEbcdic(CharacterEncode=True)
Print 'Untranslatable Unicode, character encoded:' -
And %val
End Try


<blockquote class="note">
'''Note:''' Unicode values, untranslatable or not, are always allowed when they are added to an <var>XmlDoc</var> using one of the <var class="product">Janus SOAP</var> XML Add or Insert methods which “directly store” into an <var>XmlDoc</var>. For example, the following fragment adds an <var>Element</var> node with a value that is the Unicode trademark sign: 
%node:AddElement('notation', '&#x2122;':U)

</blockquote>

===Unicode input characters===
The <var>ReplaceUnicode</var> option lets you replace certain Unicode input characters with those characters you have explicitly specified (by <var>[[Unicode#The UNICODE command|UNICODE]]</var> commands in your site's <var class="product">Model 204</var> CCAIN stream).

For example, assume the following command is in CCAIN:
UNICODE Table Standard Rep U=2122 '(tm)'

Given the above command, the <var>ReplaceUnicode</var> option for <var>[[LoadXml (XmlDoc/XmlNode function)|LoadXml]]</var> is shown in the following fragment:
 %u Unicode Initial('<a>')
%u = %u:[[UnicodeWith (Unicode function)|UnicodeWith]]('2122':X:[[Utf16ToUnicode (String function)|Utf16ToUnicode]])
%u = %u:UnicodeWith('</a>':U)
%d:LoadXml(%u, 'ReplaceUnicode')
%d:Print

The result is:
 <a>(tm)</a>


In the preceeding example, the stream of input characters to <var>LoadXml</var> contains the Unicode character U+2122. Since the <var>ReplaceUnicode</var> option applies to both the stream of input characters and to the character value of character references, consider the following fragment (assuming the same CCAIN line as above):
 %d:LoadXml('<a>&#x2122;</a>', 'ReplaceUnicode')

The result is also:

 <a>(tm)</a>


In this case, <code>U+2122</code> does not occur in the input character stream, but it is the value of the character reference.

Notes:
<ul>
<li>It is an error to be processing a replacement string within a character reference. For example, assume the following two lines are in CCAIN:
* Replace superscript 2 with digit '2':
UNICODE Table Standard Rep U=00B2 '2'

Given the above command, the following fragment gets a parse error, because the replacement string is being used as part of a character reference:
 %d:LoadXml('<a>&#x' With '&#xB2;':U With ';</a>', -
'ReplaceUnicode')

As a consequence of this rule, a replacement string should not contain an ampersand character (assuming that the <var>ReplaceUnicode</var> option will be used).

<li>Replacement of a Unicode character due to the <var>ReplaceUnicode</var> option is only done while processing names and values in the XML document. It is an error if the end of the name or value occurs and the replacement string has not been exhausted. In other words (again assuming that the <var>ReplaceUnicode</var> option will be used), a replacement string should not have “XML markup” that might end a string, such as a quotation mark or a left angle bracket (<code><</code>). For example, assume the following line is in CCAIN:
 UNICODE Table Standard Rep U=2122 '(trademark)<tm>'

Given the above command, the following fragment gets a parsing error, because the "less than" character (<tt><</tt>) that is encountered in the replacement string ends the element content:
 %d:LoadXml('<a>&#x2122;</a>':U, 'ReplaceUnicode')


<li>If a parsing error occurs after processing a Unicode character that has been replaced, the error display of the input stream will contain the replacement string, and the replaced character will not be displayed.
However, if the character being replaced was introduced as a character reference, the character reference remains in the display of the input stream.
</ul>

==Example==
In the following example, <var>ParseXml</var> deserializes into <code>%doc</code> the XML data (stored in <code>%httpresp</code>) returned from a <var>Post</var> call:
 %httpreq is object httpRequest
%httpreq = [[New_(HttpRequest_constructor)|new]]
...
%httpresp = %httpreq:post('HTTPCLI')
%doc is object xmlDoc
%doc = new
%httpresp:parseXml(%doc, 'ErrRet')
%doc:[[Print_(XmlDoc/XmlNode_subroutine)|print]]
...


==See also==
<ul>
<li>Working with <var class="product">Janus SOAP</var> <var>XmlDoc</var> objects is described in detail in [[XML processing in Janus SOAP|XML processing in Janus SOAP]].
</ul>
{{Template:HttpResponse:ParseXml footer}}

JAL at 19:30, 6 November 2012

2012-11-06T19:30:06Z

← Older revision		Revision as of 19:30, 6 November 2012
Line 115:		Line 115:

	'''Note:''' Unicode values, untranslatable or not, are always allowed when they are added to an <var>XmlDoc</var> using one of the <var class="product">Janus SOAP</var> XML Add or Insert methods which “directly store” into an <var>XmlDoc</var>. For example, the following fragment adds an <var>Element</var> node with a value that is the Unicode trademark sign:		'''Note:''' Unicode values, untranslatable or not, are always allowed when they are added to an <var>XmlDoc</var> using one of the <var class="product">Janus SOAP</var> XML Add or Insert methods which “directly store” into an <var>XmlDoc</var>. For example, the following fragment adds an <var>Element</var> node with a value that is the Unicode trademark sign:
	<p class="code"> %node:AddElement('notation', '™':U)		<p class="code">%node:AddElement('notation', '&#x2122;':U)
	</p>		</p>
	<h3>Unicode input characters</h3>		<h3>Unicode input characters</h3>
Line 121:		Line 121:

	For example, assume the following command is in CCAIN:		For example, assume the following command is in CCAIN:
	<p class="code"> UNICODE Table Standard Rep U=2122 '(tm)'		<p class="code">UNICODE Table Standard Rep U=2122 '(tm)'
	</p>		</p>
	Given the above command, the <var>ReplaceUnicode</var> option for <var>[[LoadXml (XmlDoc/XmlNode function)\|LoadXml]]</var> is shown in the following fragment:		Given the above command, the <var>ReplaceUnicode</var> option for <var>[[LoadXml (XmlDoc/XmlNode function)\|LoadXml]]</var> is shown in the following fragment:
Line 135:		Line 135:

	In the preceeding example, the stream of input characters to <var>LoadXml</var> contains the Unicode character U+2122. Since the <var>ReplaceUnicode</var> option applies to both the stream of input characters and to the character value of character references, consider the following fragment (assuming the same CCAIN line as above):		In the preceeding example, the stream of input characters to <var>LoadXml</var> contains the Unicode character U+2122. Since the <var>ReplaceUnicode</var> option applies to both the stream of input characters and to the character value of character references, consider the following fragment (assuming the same CCAIN line as above):
	<p class="code"> %d:LoadXml('<a>™</a>', 'ReplaceUnicode')		<p class="code"> %d:LoadXml('<a>&#x2122;</a>', 'ReplaceUnicode')
	</p>		</p>
	The result is also:		The result is also:
Line 147:		Line 147:
	<ul>		<ul>
	<li>It is an error to be processing a replacement string within a character reference. For example, assume the following two lines are in CCAIN:		<li>It is an error to be processing a replacement string within a character reference. For example, assume the following two lines are in CCAIN:
	<p class="code"> * Replace superscript 2 with digit '2':		<p class="code">* Replace superscript 2 with digit '2':
	UNICODE Table Standard Rep U=00B2 '2'		UNICODE Table Standard Rep U=00B2 '2'
	</p>		</p>
	Given the above command, the following fragment gets a parse error, because the replacement string is being used as part of a character reference:		Given the above command, the following fragment gets a parse error, because the replacement string is being used as part of a character reference:
	<p class="code"> %d:LoadXml('<a>&#x' With '²':U With ';</a>', -		<p class="code"> %d:LoadXml('<a>&#x' With '&#xB2;':U With ';</a>', -
	'ReplaceUnicode')		'ReplaceUnicode')
	</p>		</p>
Line 159:		Line 159:
	</p>		</p>
	Given the above command, the following fragment gets a parsing error, because the '<' that is encountered in the replacement string ends the element content:		Given the above command, the following fragment gets a parsing error, because the '<' that is encountered in the replacement string ends the element content:
	<p class="code"> %d:LoadXml('<a>™</a>':U, 'ReplaceUnicode')		<p class="code"> %d:LoadXml('<a>&#x2122;</a>':U, 'ReplaceUnicode')
	</p>		</p>
	<li>If a parsing error occurs after processing a Unicode character that has been replaced, the error display of the input stream will contain the replacement string, and the replaced character will not be displayed.		<li>If a parsing error occurs after processing a Unicode character that has been replaced, the error display of the input stream will contain the replacement string, and the replaced character will not be displayed.

JALWiccan: 1 revision

2012-11-06T18:22:49Z

1 revision

← Older revision	Revision as of 18:22, 6 November 2012
(No difference)

JAL2: /* Syntax terms */

2012-11-06T18:22:37Z

Syntax terms

← Older revision		Revision as of 18:22, 6 November 2012
Line 115:		Line 115:

	'''Note:''' Unicode values, untranslatable or not, are always allowed when they are added to an <var>XmlDoc</var> using one of the <var class="product">Janus SOAP</var> XML Add or Insert methods which “directly store” into an <var>XmlDoc</var>. For example, the following fragment adds an <var>Element</var> node with a value that is the Unicode trademark sign:		'''Note:''' Unicode values, untranslatable or not, are always allowed when they are added to an <var>XmlDoc</var> using one of the <var class="product">Janus SOAP</var> XML Add or Insert methods which “directly store” into an <var>XmlDoc</var>. For example, the following fragment adds an <var>Element</var> node with a value that is the Unicode trademark sign:
	<p class="code"> %node:AddElement('notation', '&~~amp;amp;~~#x2122;':U)		<p class="code"> %node:AddElement('notation', '™':U)
	</p>		</p>
	<h3>Unicode input characters</h3>		<h3>Unicode input characters</h3>
Line 135:		Line 135:

	In the preceeding example, the stream of input characters to <var>LoadXml</var> contains the Unicode character U+2122. Since the <var>ReplaceUnicode</var> option applies to both the stream of input characters and to the character value of character references, consider the following fragment (assuming the same CCAIN line as above):		In the preceeding example, the stream of input characters to <var>LoadXml</var> contains the Unicode character U+2122. Since the <var>ReplaceUnicode</var> option applies to both the stream of input characters and to the character value of character references, consider the following fragment (assuming the same CCAIN line as above):
	<p class="code"> %d:LoadXml('<a>&~~amp;amp;~~#x2122;</a>', 'ReplaceUnicode')		<p class="code"> %d:LoadXml('<a>™</a>', 'ReplaceUnicode')
	</p>		</p>
	The result is also:		The result is also:
Line 151:		Line 151:
	</p>		</p>
	Given the above command, the following fragment gets a parse error, because the replacement string is being used as part of a character reference:		Given the above command, the following fragment gets a parse error, because the replacement string is being used as part of a character reference:
	<p class="code"> %d:LoadXml('<a>&~~amp;amp;~~#x' With '&~~amp;amp;~~#xB2;':U With ';</a>', -		<p class="code"> %d:LoadXml('<a>&#x' With '²':U With ';</a>', -
	'ReplaceUnicode')		'ReplaceUnicode')
	</p>		</p>
Line 159:		Line 159:
	</p>		</p>
	Given the above command, the following fragment gets a parsing error, because the '<' that is encountered in the replacement string ends the element content:		Given the above command, the following fragment gets a parsing error, because the '<' that is encountered in the replacement string ends the element content:
	<p class="code"> %d:LoadXml('<a>&~~amp;amp;~~#x2122;</a>':U, 'ReplaceUnicode')		<p class="code"> %d:LoadXml('<a>™</a>':U, 'ReplaceUnicode')
	</p>		</p>
	<li>If a parsing error occurs after processing a Unicode character that has been replaced, the error display of the input stream will contain the replacement string, and the replaced character will not be displayed.		<li>If a parsing error occurs after processing a Unicode character that has been replaced, the error display of the input stream will contain the replacement string, and the replaced character will not be displayed.

JAL2: /* Syntax terms */

2012-03-09T22:23:13Z

Syntax terms

← Older revision		Revision as of 22:23, 9 March 2012
Line 31:		Line 31:
	<li>A syntax error in the text string representation of the XML document		<li>A syntax error in the text string representation of the XML document
	</ul>		</ul>
			<li><b>HtmlCharEnt</b><br>
			Allow the standard XHTML entities for element and attribute content, and convert them to the corresponding Unicode characters. You can find the list of XHTML entities on the Internet at http://www.w3.org/TR/xhtml1/dtds.html#h-A2.
	<li><b>LinefeedNoTrailingTabs</b><br>		<li><b>LinefeedNoTrailingTabs</b><br>
	For a Text node that consists of an initial line-end character and one or more tab characters, this option normalizes the content so the result is a single line-end character. The initial line-end (also called "newline") character can be a linefeed character (LF) or a carriage-return (CR) by itself, or a carriage-return followed by a linefeed (CRLF), since (within Text nodes) all of these are normalized by the XML specification into a single line-end character.		For a Text node that consists of an initial line-end character and one or more tab characters, this option normalizes the content so the result is a single line-end character. The initial line-end (also called "newline") character can be a linefeed character (LF) or a carriage-return (CR) by itself, or a carriage-return followed by a linefeed (CRLF), since (within Text nodes) all of these are normalized by the XML specification into a single line-end character.

← Older revision		Revision as of 20:32, 13 March 2014
Line 213:		Line 213:
	<ul>		<ul>
	<li>Working with <var class="product">Janus SOAP</var> <var>XmlDoc</var> objects is described in detail in [[XML processing in Janus SOAP\|XML processing in Janus SOAP]].		<li>Working with <var class="product">Janus SOAP</var> <var>XmlDoc</var> objects is described in detail in [[XML processing in Janus SOAP\|XML processing in Janus SOAP]].

			<li>For additional discussion about deserialization, see [[XmlDoc API#Transport: receiving and sending XML\|Transport: receiving and sending XML]].</li>
	</ul>		</ul>
	{{Template:HttpResponse:ParseXml footer}}		{{Template:HttpResponse:ParseXml footer}}