Difference between revisions of "XML ENCODE()"

From Recital Documentation Wiki
Jump to: navigation, search
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
{{YLM to do}}
 
 
 
==Purpose==
 
==Purpose==
 
Encode an object as a character string containing XML for use with the messaging functions to pass objects between processes
 
Encode an object as a character string containing XML for use with the messaging functions to pass objects between processes
Line 10: Line 8:
  
 
==See Also==
 
==See Also==
[[:Category:Messaging|Messaging Functions]], [[MQCLOSE()]], [[MQCREATE()]], [[MQCURMSGS()]], [[MQOPEN()]],  [[MQSEND()]], [[MQRECEIVE()]], [[XML_DECODE()]], [[XML_GATHER()]], [[XML_SCATTER()]]
+
[[:Category:Messaging|Messaging Functions]], [[MQCLOSE()]], [[MQCREATE()]], [[MQCURMSGS()]], [[MQOPEN()]],  [[MQSEND()]], [[MQRECEIVE()]], [[MQUNLINK()]], [[XML_DECODE()]], [[XML_GATHER()]], [[XML_SCATTER()]]
  
  
Line 16: Line 14:
 
The XML_ENCODE() function is used to encode an object and return a character string containing XML.  The character string returned can be used with the messaging functions to pass objects between processes.  The <object> is the object to be encoded.  The optional character expression <expC1> is the XML root tag name.  The optional character expression <expC2> is the XML row tag name.
 
The XML_ENCODE() function is used to encode an object and return a character string containing XML.  The character string returned can be used with the messaging functions to pass objects between processes.  The <object> is the object to be encoded.  The optional character expression <expC1> is the XML root tag name.  The optional character expression <expC2> is the XML row tag name.
  
The XML_DECODE() function returns the passed XML character string decoded back into an object.
+
The XML_DECODE() function is used to return the passed XML character string decoded back into an object.
  
  
 
==Example==
 
==Example==
 
<code lang="recital">
 
<code lang="recital">
 
+
// Open up the queue for read/write access
 +
mqdes=mqcreate("/myqueue2", 2)
 +
if (mqdes < 0)
 +
    messagebox(strerror()+",errno="+alltrim(str(error())))
 +
    return
 +
endif
 +
// send a message to the queue
 +
rc = mqsend(mqdes, xml_encode(tran_obj))
 +
if (rc < 0)
 +
    messagebox(strerror()+",errno="+alltrim(str(error())))
 +
    return
 +
endif
 +
mqclose(mqdes)
 
</code>
 
</code>
  

Latest revision as of 10:11, 5 July 2011

Purpose

Encode an object as a character string containing XML for use with the messaging functions to pass objects between processes


Syntax

XML_ENCODE(<object> [, <expC1>, <expC2>])


See Also

Messaging Functions, MQCLOSE(), MQCREATE(), MQCURMSGS(), MQOPEN(), MQSEND(), MQRECEIVE(), MQUNLINK(), XML_DECODE(), XML_GATHER(), XML_SCATTER()


Description

The XML_ENCODE() function is used to encode an object and return a character string containing XML. The character string returned can be used with the messaging functions to pass objects between processes. The <object> is the object to be encoded. The optional character expression <expC1> is the XML root tag name. The optional character expression <expC2> is the XML row tag name.

The XML_DECODE() function is used to return the passed XML character string decoded back into an object.


Example

// Open up the queue for read/write access
mqdes=mqcreate("/myqueue2", 2)
if (mqdes < 0)
    messagebox(strerror()+",errno="+alltrim(str(error())))
    return
endif
// send a message to the queue
rc = mqsend(mqdes, xml_encode(tran_obj))
if (rc < 0)
    messagebox(strerror()+",errno="+alltrim(str(error())))
    return
endif
mqclose(mqdes)


Products

Recital, Recital Server