GetMessageTimeout method

Returns the next available QAMessage sent to the given address.

Syntax
Visual Basic
Public Function GetMessageTimeout( _
   ByVal address As String, _
   ByVal timeout As Long _
) As QAMessage
C#
public QAMessage GetMessageTimeout(
   string  address,
   long timeout
);
Parameters
  • address   Specifies the queue name used by the QAnywhere client to receive messages.

  • timeout   The time to wait, in milliseconds, for a message to become available.

Return value

The next QAMessage, or null if no message is available.

Remarks

The address parameter specifies a local queue name. The address can be in the form store-id\queue-name or queue-name.

If no message is available, this method waits for the specified timeout and then returns. Use this method to receive messages synchronously.

For more information about receiving messages asynchronously (using a message event handler), see Receiving messages asynchronously.

Exceptions