AddXml (HttpRequest subroutine) - Revision history

JAL: /* See also */

2014-03-18T21:04:36Z

JAL: /* Syntax terms */

2014-03-18T20:00:45Z

Syntax terms

← Older revision		Revision as of 20:00, 18 March 2014
Line 24:		Line 24:
	Inserts space characters and line-ends into the serialized string such that if the string is broken at the line-ends and displayed as a tree, the display of each lower level in the subtree is indented ''n'' spaces from the previous level's starting point. You may also specify <var>CR</var>, <var>LF</var>, <var>CRLF</var>, or <var>Newline</var> (see below). If <var>Indent</var> is specified and no line-end options are also specified, <var>Newline</var> is implied. </li>		Inserts space characters and line-ends into the serialized string such that if the string is broken at the line-ends and displayed as a tree, the display of each lower level in the subtree is indented ''n'' spaces from the previous level's starting point. You may also specify <var>CR</var>, <var>LF</var>, <var>CRLF</var>, or <var>Newline</var> (see below). If <var>Indent</var> is specified and no line-end options are also specified, <var>Newline</var> is implied. </li>

	<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), <b>CRLF</b> (carriage-return followed by a linefeed), or <b>Newline</b> (line-end set for the <var class="product">Janus Web</var> connection)<br>		<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), <b>CRLF</b> (carriage-return followed by a linefeed), or <b>Newline</b> (line-end set for the <var class="product">Janus Web</var> connection)<p>
	Inserts one of these line-end options to provide line breaks in the serialized output. </p></li>		Inserts one of these line-end options to provide line breaks in the serialized output. </p></li>

JAL: /* See also */

2014-03-13T20:54:45Z

JAL: /* See also */

2014-03-13T20:43:03Z

JAL: /* Syntax terms */

2014-03-09T18:13:46Z

Syntax terms

← Older revision		Revision as of 18:13, 9 March 2014
Line 9:		Line 9:
	<td>A previously defined and instantiated <var>HttpRequest</var> object.		<td>A previously defined and instantiated <var>HttpRequest</var> object.
	</td></tr>		</td></tr>

	<tr><th>doc</th>		<tr><th>doc</th>
	<td>A previously defined and instantiated <var>XmlDoc</var> object.		<td>A previously defined and instantiated <var>XmlDoc</var> object.
	</td></tr>		</td></tr>

	<tr><th>options</th>		<tr><th>options</th>
	<td>Any combination of the following options (but single occurrences only). <br>'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]].		<td>Any combination of the following options (but single occurrences only).
			<p class="note">'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]]. </p>
	<ul>		<ul>
	<li><b>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>		<li><b>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>
	AllowXmlDecl, the default, produces the "XML Declaration" (that is, <code><?xml version=...?></code>) if the value of the <var>[[Version (XmlDoc property)\|Version]]</var> property in <var class="term">doc</var> is a non-null string. <var>NoXmlDecl</var> omits the XML declaration.		AllowXmlDecl, the default, produces the "XML Declaration" (that is, <code><?xml version=...?></code>) if the value of the <var>[[Version (XmlDoc property)\|Version]]</var> property in <var class="term">doc</var> is a non-null string. <var>NoXmlDecl</var> omits the XML declaration.</li>

	<li><b>Indent</b> <i><b>n</b></i><br>		<li><b>Indent</b> <i><b>n</b></i><br>
	Inserts space characters and line-ends into the serialized string such that if the string is broken at the line-ends and displayed as a tree, the display of each lower level in the subtree is indented ''n'' spaces from the previous level's starting point. You may also specify <var>CR</var>, <var>LF</var>, <var>CRLF</var>, or <var>Newline</var> (see below). If <var>Indent</var> is specified and no line-end options are also specified, <var>Newline</var> is implied.		Inserts space characters and line-ends into the serialized string such that if the string is broken at the line-ends and displayed as a tree, the display of each lower level in the subtree is indented ''n'' spaces from the previous level's starting point. You may also specify <var>CR</var>, <var>LF</var>, <var>CRLF</var>, or <var>Newline</var> (see below). If <var>Indent</var> is specified and no line-end options are also specified, <var>Newline</var> is implied. </li>

	<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), <b>CRLF</b> (carriage-return followed by a linefeed), or <b>Newline</b> (line-end set for the <var class="product">Janus Web</var> connection)<br>		<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), <b>CRLF</b> (carriage-return followed by a linefeed), or <b>Newline</b> (line-end set for the <var class="product">Janus Web</var> connection)<br>
	Inserts one of these line-end options to provide line breaks in the serialized output.		Inserts one of these line-end options to provide line breaks in the serialized output. </p></li>

	<li><b>NoEmptyElt</b><br>		<li><b>NoEmptyElt</b><br>
	~~Deprecated as of <var class="product">[[Sirius Mods]]</var> Version 7.0, this~~ option ~~ensures that~~ all empty elements ~~are serialized~~ with a start tag followed by an end tag. The default is to serialize an empty element with an empty element tag (as in <code><middleName/></code>).		This deprecated option serializes all empty elements with a start tag followed by an end tag. The default is to serialize an empty element with an empty element tag (as in <code><middleName/></code>).
			<p>
			<var>NoEmptyElt</var> is deprecated in order to deter users from using it to serialize HTML: The recommended approach for HTML is shown on the <var>[[NoEmptyElement (XmlNode property)#browserExample\|NoEmptyElement]]</var> property page — some tags (<code><div></code>) <b>require</b> separate start and end tags, while other tags (<code><br></code>) <b>do not allow</b> separate start and end tags. </p></li>

	<li><b>OmitNullElement</b><br>		<li><b>OmitNullElement</b><br>
	An <var>Element</var> node that has no children and no <var>Attributes</var> will not be serialized, unless it is the top level <var>Element</var> in the subtree being serialized.		An <var>Element</var> node that has no children and no <var>Attributes</var> will not be serialized, unless it is the top level <var>Element</var> in the subtree being serialized.</li>

	<li><b>SortCanonical</b><br>		<li><b>SortCanonical</b><br>
	This deprecated option, serializes namespace declarations and attributes in sorted order (from lowest to highest with Unicode code ordering). It is superseded by the <var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> method <var>ExclCanonical</var> option.</ul>		This deprecated option, serializes namespace declarations and attributes in sorted order (from lowest to highest with Unicode code ordering). It is superseded by the <var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> method <var>ExclCanonical</var> option.</li>
			</ul>
	</td></tr></table>		</td></tr></table>

Dme at 14:13, 13 September 2012

2012-09-13T14:13:25Z

← Older revision		Revision as of 14:13, 13 September 2012
Line 52:		Line 52:
	%sl is object [[Stringlist_class\|stringlist]]		%sl is object [[Stringlist_class\|stringlist]]
	%sl = [[New_(Stringlist_constructor)\|new]]		%sl = [[New_(Stringlist_constructor)\|new]]
	[[Text_and_Html_statements#~~The_HTML_or_TEXT_statement~~\|text to]] %sl		[[Text_and_Html_statements#toOption\|text to]] %sl
	<top p:abc="p" q:xyz="q"		<top p:abc="p" q:xyz="q"
	xmlns:p="urn:p" xmlns:q=<nowiki>"http://q.com"</nowiki>		xmlns:p="urn:p" xmlns:q=<nowiki>"http://q.com"</nowiki>

JAL2: /* Examples */

2011-06-24T21:47:01Z

Examples

← Older revision		Revision as of 21:47, 24 June 2011
Line 63:		Line 63:
	end		end
	</p>		</p>
	The <var>print</var> statement above (which uses the <var class="product">[[Janus SOAP]]</var> [[XmlDoc API]] <var>~~serial~~</var> method) displays the resulting <var>XmlDoc</var> content added to the <var>HttpRequest</var> object (formatted with some newlines for the sake of instruction):		The <var>print</var> statement above (which uses the <var class="product">[[Janus SOAP]]</var> [[XmlDoc API]] <var>Serial</var> method) displays the resulting <var>XmlDoc</var> content added to the <var>HttpRequest</var> object (formatted with some newlines for the sake of instruction):
	<p class="code"><top		<p class="code"><top
	xmlns:p="urn:p" xmlns:q=<nowiki>"http://q.com"</nowiki>		xmlns:p="urn:p" xmlns:q=<nowiki>"http://q.com"</nowiki>

JAL2: /* Syntax terms */

2011-06-22T20:21:48Z

Syntax terms

← Older revision		Revision as of 20:21, 22 June 2011
Line 13:		Line 13:
	</td></tr>		</td></tr>
	<tr><th>options</th>		<tr><th>options</th>
	<td>Any combination of the following options (but single occurrences only):		<td>Any combination of the following options (but single occurrences only). <br>'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]].
	<ul>		<ul>
	<li><b>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>		<li><b>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>
Line 27:		Line 27:
	<li><b>SortCanonical</b><br>		<li><b>SortCanonical</b><br>
	This deprecated option, serializes namespace declarations and attributes in sorted order (from lowest to highest with Unicode code ordering). It is superseded by the <var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> method <var>ExclCanonical</var> option.</ul>		This deprecated option, serializes namespace declarations and attributes in sorted order (from lowest to highest with Unicode code ordering). It is superseded by the <var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> method <var>ExclCanonical</var> option.</ul>
	~~'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]].~~
	</td></tr></table>		</td></tr></table>

JAL2 at 19:06, 21 June 2011

2011-06-21T19:06:59Z

← Older revision		Revision as of 19:06, 21 June 2011
Line 1:		Line 1:
	{{Template:HttpRequest:AddXml subtitle}}		{{Template:HttpRequest:AddXml subtitle}}
	The <var>AddXml</var> subroutine adds a <var class="product">[[Janus SOAP]]</var> [[XmlDoc_API#The_XmlDoc_class\|XmlDoc]] object instance to the HTTP Post data that is subsequently sent on a <var>[[Post (HttpRequest function)\|Post]]</var> method invocation.		The <var>AddXml</var> subroutine adds a <var class="product">[[Janus SOAP]]</var> <var>[[XmlDoc_API#The_XmlDoc_class\|XmlDoc]]</var> object instance to the HTTP Post data that is subsequently sent on a <var>[[Post (HttpRequest function)\|Post]]</var> method invocation.

	==Syntax==		==Syntax==
Line 45:		Line 45:

	==Examples==		==Examples==
	~~<ol><li>~~The following example shows the effect of the <var>NoEmptyElt</var> option:		The following example shows the effect of the <var>NoEmptyElt</var> option:
	<p class="code">begin		<p class="code">begin
	%d is object [[XmlDoc_API#The_XmlDoc_class\|xmlDoc]]		%d is object [[XmlDoc_API#The_XmlDoc_class\|xmlDoc]]
Line 75:		Line 75:
	<var>NoEmptyElt</var> produces an STag (<code><top ...></code>) and an ETag (<code></top></code>) for an empty element, rather than just the EmptyElemTag (<code><top ...></code>).		<var>NoEmptyElt</var> produces an STag (<code><top ...></code>) and an ETag (<code></top></code>) for an empty element, rather than just the EmptyElemTag (<code><top ...></code>).
	</ul>		</ul>
	~~</ol>~~

	==See also==		==See also==
	{{Template:HttpRequest:AddXml footer}}		{{Template:HttpRequest:AddXml footer}}

JAL2: /* Usage notes */

2011-06-21T16:52:38Z

Usage notes

← Older revision		Revision as of 16:52, 21 June 2011
Line 33:		Line 33:
	<ul>		<ul>
	<li>The <var>XmlDoc</var> that is passed is serialized into the post data of the request being built. It is not required that you serialize the <var>XmlDoc</var> first.		<li>The <var>XmlDoc</var> that is passed is serialized into the post data of the request being built. It is not required that you serialize the <var>XmlDoc</var> first.
	<li>Invoking this method erases any post data previously added by <var>AddXml</var> or <var>[[~~AddLongString~~ (HttpRequest subroutine)\|~~AddLongString~~]]</var> method calls.		<li>Invoking this method erases any post data previously added by <var>AddXml</var> or <var>[[AddLongstring (HttpRequest subroutine)\|AddLongstring]]</var> method calls.
	<li>If you do not explicitly set a content-type HTTP request header via <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>, <var>AddXml</var> generates a content-type header of "text/xml" upon a Post. To suppress this automatic header generation, you can set the <var>[[AutoSendXmlContentType (HttpRequest property)\|AutoSendXmlContentType]]</var> property to <code>False</code>.		<li>If you do not explicitly set a content-type HTTP request header via <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>, <var>AddXml</var> generates a content-type header of "text/xml" upon a Post. To suppress this automatic header generation, you can set the <var>[[AutoSendXmlContentType (HttpRequest property)\|AutoSendXmlContentType]]</var> property to <code>False</code>.
	<li>The <var class="term">options</var> may be specified in any case, for example, you can use		<li>The <var class="term">options</var> may be specified in any case, for example, you can use

← Older revision		Revision as of 21:04, 18 March 2014
Line 94:		Line 94:
	<li><var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var>		<li><var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var>
	<li><var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var>		<li><var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var>
	<li><var>[[~~WebReceive~~ (XmlDoc ~~function~~)\|~~WebReceive~~]]</var>		<li><var>[[WebSend (XmlDoc subroutine)\|WebSend]]</var>
	</ul> </li>		</ul> </li>
	</ul>		</ul>

	{{Template:HttpRequest:AddXml footer}}		{{Template:HttpRequest:AddXml footer}}

← Older revision		Revision as of 20:54, 13 March 2014
Line 89:		Line 89:
	<ul>		<ul>
	<li>For additional discussion about serialization, see [[XmlDoc API#Transport: receiving and sending XML\|Transport: receiving and sending XML]].</li>		<li>For additional discussion about serialization, see [[XmlDoc API#Transport: receiving and sending XML\|Transport: receiving and sending XML]].</li>

			<li>Additional non-<var>HttpRequest</var> serializing methods include:
			<ul>
			<li><var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var>
			<li><var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var>
			<li><var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>
			</ul> </li>
	</ul>		</ul>

	{{Template:HttpRequest:AddXml footer}}		{{Template:HttpRequest:AddXml footer}}

← Older revision		Revision as of 20:43, 13 March 2014
Line 87:		Line 87:

	==See also==		==See also==
			<ul>
			<li>For additional discussion about serialization, see [[XmlDoc API#Transport: receiving and sending XML\|Transport: receiving and sending XML]].</li>
			</ul>

	{{Template:HttpRequest:AddXml footer}}		{{Template:HttpRequest:AddXml footer}}