SyncRequestXmlDoc function

Syntax

SyncRequestXmlDoc(&XmlDoc, Message.MessageName [, Node.NodeName])

Description

Use the SyncRequestXmlDoc function to send a synchronous message that is based on an XmlDoc object.

Note:

This function has been desupported and remains for backward compatibility only. Use the IntBroker class SyncRequest method instead.

See PeopleCode API Reference: SyncRequest method: IntBroker class.

The XmlDoc object must already be instantiated and populated. The message included in the function call should be an unstructured message, that is, one that isn't based on a hierarchical record structure.

If you want to handle an XmlDoc as a Message object, you need to define a Message object with a hierarchical structure and migrate the data in the XmlDoc object into the Message object.

Parameters

Parameter Description

&XmlDoc

Specify an already instantiated and populated XmlDoc object that you want to send as a synchronous message.

MessageName

Specify an already existing nonrowset-based message, prefixed with the reserved word Message.

NodeName

Specify a node. This is for Sender Specified Routing (SSR) prefixed with the reserved word Node. The node defines the target for the published message.

Returns

A reference to an XmlDoc object that is the response.

Example

Local XmlDoc &reqdoc, &respdoc;
. . .
&respdoc = SyncRequestXmlDoc(&reqdoc, Message.MY_MESSAGE, Node.MY_NODE);