CancelPubXmlDoc
Mon 01 January 2018Syntax
CancelPubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubNode[, Segment])
Description
Use the CancelPubXmlDoc function to programmatically cancel a message 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.
This is the publication contract that exists after any transformations have been preformed.
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. |
| 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 Boolean value: True if the function completed successfully, False otherwise.