CancelSubXmlDoc
Mon 01 January 2018Syntax
CancelSubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubscriptionName[, Segment])
Description
Use the CancelSubXmlDoc function to programmatically cancel a message subscription 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 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 as a string. |
| PubNode |
Specify the Pub Node name as a string. |
| ChannelName |
Specify the Channel name as a string. |
| VersionName |
Specify the version name as a string. |
| MessageName |
Specify the message name as a string. |
| SubscriptionName |
Specify the subscription name as a string. |
| 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.