UpdateXmlDoc
Mon 01 January 2018Syntax
UpdateXmlDoc(&XmlDoc, PubID, PubNode, ChannelName, VersionName [, Message Name [, SubNode[, Segment]]])
Description
Use the UpdateXmlDoc function to update a message in the message queue with the specified message version.
Note: This function has been deprecated and remains for backward compatibility only. Use the IntBroker class UpdateXmlDoc method instead.
If VersionName isnât specified, the default message version is used. This method is commonly used in the OnRouteSend and OnRouteReceive PeopleCode events.
Note: This function can't be called from notification PeopleCode.
Parameters
|
Field or Control |
Definition |
|---|---|
| &XmlDoc |
Specify an already instantiated XmlDoc object. |
| PubID |
Specify the PubID as a string. |
| PubNode |
Specify the PubNode as a sting. |
| ChannelName |
Specify the Channel name as a string. |
| VersionName |
Specify the version name as a string. |
| MessageName |
Specify the message name as a string. This is only used for Pub and Sub contracts. |
| SubNode |
Specify the sub node as a string. This is only used for Pub contracts. |
| Segment |
Specify an integer representing which segment you want to access. The default value is one, which means that if you do not specify a segment, the first segment is accessed. |
Returns
A Boolean value: True if function completed successfully, False otherwise.