ABORT_MESSAGE_FUNCTION

The ABORT_MESSAGE_FUNCTION function aborts the transmission of a scheduled, sending or receiving message at the server. The message will be moved to the fax server's sent queue. The MESSAGE_HANDLE returned from either the SEND_MESSAGE or GET_Q_ENTRIES_INFO function must be present in the taglist to specify which message to abort.

You must provide valid REGISTERED_NAME and REGISTERED_PASSWORD tags in the taglist for this function to execute. This function allows a user to abort their own messages, and a supervisor to abort messages belonging to any user.

Type

Max Size

Multiple Allowed

Function

N/A

Example:

function AbortMessage( MessageHandle)
{
var Tl = CAS.New();
CAS.AddTag(Tl,"ABORT_MESSAGE_FUNCTION","");
CAS.AddTag(Tl,"REGISTERED_NAME",UserName);
CAS.AddTag(Tl,"REGISTERED_PASSWORD",UserPassword);
CAS.AddTag(Tl,"MESSAGE_HANDLE",MessageHandle);

// Abort message on this already open session
Tl = CAS.Send(cInst,Tl);

LastErrorNum = CAS.GetTag(Tl,"STATUS_NUM",0);
LastErrorStr = CAS.GetTag(Tl,"STATUS",0);
CAS.Delete(Tl);

return( LastErrorNum);
}