WebReceive (XmlDoc function): Difference between revisions
m (1 revision) |
m (→Example) |
||
Line 48: | Line 48: | ||
<var>WebReceive</var> to obtain the XML document from the HTTP request: | <var>WebReceive</var> to obtain the XML document from the HTTP request: | ||
<p class="code">Begin | <p class="code">Begin | ||
%d | %d Object XmlDoc | ||
%d = New | %d = New | ||
%d: | %d:WebReceive | ||
%d2 | %d2 Object XmlDoc | ||
%d2 = New | %d2 = New | ||
%d2:LoadXml('<sum>' With - | %d2:LoadXml('<sum>' With - | ||
%d:Value('/*/*[1]') + %d:Value('/*/*[2]') - | %d:Value('/*/*[1]') + %d:Value('/*/*[2]') - | ||
With '</sum>') | |||
%d2:WebSend | %d2:WebSend | ||
End | End |
Revision as of 17:36, 7 February 2011
Deserialize Web request into this XmlDoc (XmlDoc class)
[Requires Janus SOAP]
This callable function
converts an HTTP request received on a Janus Web Server thread from the text
representation of an
XML document to an XmlDoc tree (this process is called deserialization,
because the text representation of a document is called the serial
form).
It returns a zero value if the
deserialization is successful or a non-zero value if unsuccessful and
the ErrRet option is used and the particular error is tolerated.
Syntax
[%errorPosition =] doc:WebReceive[( [formFieldname], [fieldOccurrence], - [options])] Throws XmlParseError
Syntax terms
%pos | A %variable set to 0 if the deserialization is successful, or, if the ErrRet option is used, to the position within the uploaded data at which an error is found. |
---|---|
doc | An expression that points to the XmlDoc to contain the deserialized representation of the XML document. |
fldNam | The name of the form field associated with the "<input type=file>" tag in the HTML form, that is, the value of the "name" parameter in that tag. See the "fieldname" argument of $Web_Proc_Recv in the &JANWEBR.. |
fldOcc | The number of the form field associated with the "<input type=file>" tag in the HTML form. See the "occurrence" argument of $Web_Proc_Recv in the &JANWEBR.. |
options | See the "options" argument of ??LoadXml. |
Exceptions
This function can throw the following exception:
- XmlParseError
- If the method encounters a parsing error, properties of the exception object may indicate the location and type of problem. See ?? refid=xmlpars..
Usage notes
- See the LoadXml function ?? reftxt='Usage Notes' refid=unlxml..
Example
The following Janus Web Server program uses WebReceive to obtain the XML document from the HTTP request:
Begin %d Object XmlDoc %d = New %d:WebReceive %d2 Object XmlDoc %d2 = New %d2:LoadXml('<sum>' With - %d:Value('/*/*[1]') + %d:Value('/*/*[2]') - With '</sum>') %d2:WebSend End
Request-Cancellation Errors
- XmlDoc is not EMPTY.
- Option is invalid.
- Insufficient free space exists in CCATEMP.
- A syntax error occurred in the text string representation of the XML document (these are tolerated if the ERRRET option is specified).