WebReceive (XmlDoc function)

Deserialize Web request into XmlDoc

WebReceive is a member of the XmlDoc class.

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

  [%pos =] doc:WebReceive([fldNam], [fldOcc], [options])

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).

See Also

• If you want to deserialize a string, use ??LoadXml.
• The subroutine that serializes an XmlDoc and sends it as a Web response is WebSend, described below in ??WebSend.