GetPubXmlDoc
Mon 01 January 2018Syntax
GetPubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubNode [, Segment])
Description
Use the GetPubXmlDoc function to retrieve a message from the message queue.
Note: This function has been deprecated and remains for backward compatibility only. Use the IntBroker class GetMessage method instead.
This is the message after any transformations have been preformed. It creates and loads a data tree for the specified message version, and returns NULL if not successful. This function is used for publication contract error correction when the error correction process needs to fetch a particular message instance for the publication contract in error. SQL on the Publication Contract table is used to retrieve the key fields.
Note: This function should not be used in standard message processing. It should only be used when correcting or debugging a publication contract that is in error.
Parameters
|
Field or Control |
Definition |
|---|---|
| PubID |
Specify the PubID of the message. |
| PubNode |
Specify the Pub Node Name of the message. |
| ChannelName |
Specify the channel name of the message. |
| VersionName |
Specify the version name of the message. |
| MessageName |
Specify the name of the message. |
| SubNode |
Specify the subnode of the message. |
| 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 reference to an XmlDoc object if successful, NULL if not successful.