GetPubHeaderXmlDoc
Mon 01 January 2018Syntax
GetPubHeaderXmlDoc(PubID, PubNode, ChannelName, VersionName[, Segment])
Description
Use the GetPubHeaderXmlDoc function to retrieve the message header from the message queue.
Note: This function has been deprecated and remains for backward compatibility only. Use the IntBroker class GetMessage method instead.
The message header, also known as the message instance, is the published message before any transformations were performed.
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. |
| 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.