MESSAGE_STATUS

The MESSAGE_STATUS integer tag is included in message taglists returned by the GET_Q_ENTRIES INFO function. This tag describes the fax communications status for a message. It has particular value for messages in the fax server's sending and receiving queues.

The MESSAGE_STATUS tag can be set to one of the following values:
	PENDING	0	Queued for Send
	DIALING	1	Off Hook and Dialing
	CONNECTING	2	Interpage Handshaking
	SENDING_OR_RECEIVING	3	Data is being transferred
	DISCONNECTING	4	Hanging up the line
	COMPLETED	5	Processing Complete
	ABORTING	6	In process of aborting
	GENERATED	7	Conversion Completed
	PREPROCESSING	8	Currently Being Converted

Type

Max Size

Multiple Allowed

Integer

4 bytes

Example:

function FaxMessageIsDialing( MessageHandle )
  {
  var Tl, Sl;
  var Dialing = false;

  Tl = CAS.New();
  CAS.AddTag(Tl,"GET_Q_ENTRIES_INFO","");
  CAS.AddTag(Tl,"REGISTERED_NAME","Fred");
  CAS.AddTag(Tl,"REGISTERED_PASSWORD","");
  CAS.AddTag(Tl,"USER_NAME","Fred");
  CAS.AddTag(Tl,"SPECIFIED_MESSAGE_HANDLE",MessageHandle);

  Sl = CAS.CreateSection(Tl,"RESPONSE_INCLUDE_ONLY","");
   CAS.AddTag(Sl,"MESSAGE_STATUS",0);
  CAS.CloseSection(Sl);
   
    // Get information for message on this already open session
  Tl = CAS.Send(Instance,Tl);
  
  if ( CAS.GetTag(Tl,"STATUS_NUM",0) == 0 )
    {
    Sl = CAS.OpenSection(Tl,"MESSAGE_HANDLE");
      if (CAS.GetTag(Sl,"MESSAGE_STATUS",0) == 1)
        {
        Dialing = true;
        }
    CAS.CloseSection(Sl);
    }

  CAS.Delete(Tl);

  return(Dialing);
  }