FaxBack Developer NSSOAP

abort_message

The abort_message method aborts the transmission of a scheduled, sending or receiving message at the server. Aborted outbound messages will be moved to the fax server Sent queue (unless the message was originally submitted to be deleted upon completion), and inbound messages will be moved to the fax server Received queue.

ABORT_MESSAGE_RESULT abort_message(
string user_name,	// Fax server user name
string user_password,	// Fax server user password
string message_handle	// Message to abort
)

Parameters:

user_name	A NET SatisFAXtion user name.
user_password	The password for the user.
message_handle	The handle of the message to abort. To obtain a message handle, call get_message_q and use the message_handle field of a Q_MESSAGE object, or use the message handle returned from send_message.

Return Value:

An ABORT_MESSAGE_RESULT object containing a result code and string.

Example:

public void abort_message(string message_handle)
  {
  NSSOAP ns = new NSSOAP();

  ns.abort_message("supervisor","",message_handle);
  }