Syntax

qa_bool QAManagerBase::cancelMessage(
  qa_const_string msgid
)

Parameters

Remarks

Cancels the message with the given message ID.

The cancelMessage method 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.

The cancelMessage method 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.

Returns

True if and only if the operation succeeded.