@GetQueue

Gets the next message from the message queue with the queue handle VSPECQUEUEHANDLE QUEUEHANDLE.
On success, the message (TEXT) is returned, otherwise @ERROR (one-parameter version only, otherwise "" (NULLSTRING)).

FN FNOPTIONS:
0   = The function does not wait for a message; if no message is available, "" (NULLSTRING) is returned.
1   = Waits for the next message, taking FN FNTIMEOUT.

FN FNTIMEOUT:

0   = Wait until a message is available.
>0   = Wait time in milliseconds; if no message is then available, "" (NULLSTRING) is returned.

If @GetQueue ohne FN FNOPTIONS und FN FNTIMEOUT is called, the function does not wait for a message (FN FNOPTIONS=0).

Example: @GetQueue(QUEUEHANDLE);

TEXTQUEUENAME:="QUEUE_NAME_1";
Ret:=@CreateQueue(TEXTQUEUENAME);
QUEUEHANDLE:=@OpenQueue(TEXTQUEUENAME);

TEXTMESSAGE:="Test Message";
FNPRIORITY:=1;
@PutQueue(QUEUEHANDLE;FNPRIORITY;TEXTMESSAGE);

Message:=@GetQueue(QUEUEHANDLE);

@LogReport(Message);

QUEUEHANDLE:=@CloseQueue(QUEUEHANDLE);

A message queue named "QUEUE_NAME_1" is created and opened.
The message "Test Message" is put into the message queue.
The message is then retrieved from the message queue again and output in the APILog is output.
The message queue is then closed again.

Example: @GetQueue(QUEUEHANDLE;FNOPTIONS;FNTIMEOUT);

TEXTQUEUENAME:="QUEUE_NAME_1";
Ret:=@CreateQueue(TEXTQUEUENAME);
QUEUEHANDLE:=@OpenQueue(TEXTQUEUENAME);

TEXTMESSAGE:="Test Message";
FNPRIORITY:=1;
@PutQueue(QUEUEHANDLE;FNPRIORITY;TEXTMESSAGE);

FNOPTIONS:=1;
FNTIMEOUT:=0;
Message:=@GetQueue(QUEUEHANDLE;FNOPTIONS;FNTIMEOUT);

@LogReport(Message);

QUEUEHANDLE:=@CloseQueue(QUEUEHANDLE);

A message queue named "QUEUE_NAME_1" is created and opened.
The message "Test Message" is put into the message queue.
The message is then retrieved from the message queue again (the function waits until a message is available) and output in the APILog is output.
The message queue is then closed again.

Example: @GetQueue(QUEUEHANDLE;FNOPTIONS;FNTIMEOUT);

TEXTQUEUENAME:="QUEUE_NAME_1";
Ret:=@CreateQueue(TEXTQUEUENAME);
QUEUEHANDLE:=@OpenQueue(TEXTQUEUENAME);

TEXTMESSAGE:="Test Message";
FNPRIORITY:=1;
@PutQueue(QUEUEHANDLE;FNPRIORITY;TEXTMESSAGE);

FNOPTIONS:=0;
FNTIMEOUT:=1000;
Message:=@GetQueue(QUEUEHANDLE;FNOPTIONS;FNTIMEOUT);

@LogReport(Message);

QUEUEHANDLE:=@CloseQueue(QUEUEHANDLE);

A message queue named "QUEUE_NAME_1" is created and opened.
The message "Test Message" is put into the message queue.
The message is then retrieved from the message queue again (the function waits one second for a message if no message is available at the time of the call) and output in the APILog is output.
The message queue is then closed again.

Note : This text was machine-translated and may contain inaccuracies.