CancelPubHeaderXmlDoc
Mon 01 January 2018Syntax
CancelPubHeaderXmlDoc(PubID, PubNode, ChannelName, VersionName)
Description
Use the CancelPubHeaderXmlDoc function to programmatically cancel the message header of a publication contract, much the same as you can do in the message monitor.
Note: This function has been deprecated and remains for backward compatibility only. Use the IntBroker class Cancel method instead.
The message header, also known as the message instance, is the published message before the system performs any transformations.
The function is only available when the message has one of the following statuses:
-
Error
-
New
-
Retry
-
Timeout
-
Edited
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. |
Returns
A Boolean value: True if the function completed successfully, False otherwise.