Cancels the message with the given message ID.

Syntax

Visual Basic
Public Sub CancelMessage( _
   ByVal msgid As String _
)

C#
public void CancelMessage(
   string  msgid
);

Parameters

Remarks

CancelMessage puts a message into a canceled state before it is transmitted. With the default delete rules of the QAnywhere Agent, canceled messages are eventually deleted from the message store.

CancelMessage fails if the message is already in a final state, or if it has been transmitted to the central messaging server.

For more information about delete rules, see Message delete rules.

Exceptions