get_message_queue_paramT_get_message_queue_paramGetMessageQueueParamGetMessageQueueParam (Operator)

Name

get_message_queue_paramT_get_message_queue_paramGetMessageQueueParamGetMessageQueueParam — Abfragen der Parameter einer Warteschlange für Nachrichten.

Signatur

get_message_queue_param( : : QueueHandle, GenParamName : GenParamValue)

Beschreibung

get_message_queue_paramget_message_queue_paramGetMessageQueueParamGetMessageQueueParamGetMessageQueueParam fragt die aktuellen Werte der Parameter einer Warteschlange oder Informationen zu ihrem Status ab.

Es können mit einem einzelnen Aufruf von get_message_queue_paramget_message_queue_paramGetMessageQueueParamGetMessageQueueParamGetMessageQueueParam mehrere Werte abgefragt werden, indem GenParamNameGenParamNameGenParamNameGenParamNamegenParamName mehrere Parameternamen übergeben werden. Die Parameterwerte werden in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue in korrespondierender Reihenfolge zu den Parameternamen zurückgegeben.

Es werden folgende Parameternamen unterstützt:

'is_empty'"is_empty""is_empty""is_empty""is_empty":: Gibt den Wert 1 zurück, wenn die Warteschlange leer ist, sonst 0.
'message_num'"message_num""message_num""message_num""message_num":: Gibt die Anzahl der Nachrichten zurück, die aktuell in der Warteschlange eingereiht sind.
'max_message_num'"max_message_num""max_message_num""max_message_num""max_message_num":: Gibt den aktuellen Wert für die maximale Anzahl von Nachrichten zurück, die in einer Warteschlange eingereiht werden können. Dieser Wert kann mit set_message_queue_paramset_message_queue_paramSetMessageQueueParamSetMessageQueueParamSetMessageQueueParam eingestellt werden. Die Voreinstellung -1 bedeutet, dass eine unbegrenzte Anzahl von Nachrichten eingereiht werden kann.

Ausführungsinformationen

Multithreading-Typ: reentrant (läuft parallel zu nicht-exklusiven Operatoren).
Multithreading-Bereich: global (kann von jedem Thread aufgerufen werden).
Wird ohne Parallelisierung verarbeitet.

Parameter

QueueHandleQueueHandleQueueHandleQueueHandlequeueHandle (input_control) message_queue → (handle)

Warteschlangenobjekt.

Parameteranzahl: QueueHandle == 1

Restriktion: QueueHandle != 0

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control) string(-array) → (string)

Parameternamen.

Parameteranzahl: GenParamName == GenParamValue

Defaultwert: 'max_message_num' "max_message_num" "max_message_num" "max_message_num" "max_message_num"

Werteliste: 'is_empty'"is_empty""is_empty""is_empty""is_empty", 'max_message_num'"max_message_num""max_message_num""max_message_num""max_message_num", 'message_num'"message_num""message_num""message_num""message_num"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control) tuple(-array) → (string / integer / real)

Abgefragte Parameterwerte.

Parameteranzahl: GenParamName == GenParamValue

Beispiel (HDevelop)

create_message_queue (QueueHandle)
set_message_queue_param ( QueueHandle, 'max_message_num', 10)
* ...
get_message_queue_param( QueueHandle, 'message_num', Num)

Ergebnis

Wenn alle Parameter gültig sind liefert get_message_queue_paramget_message_queue_paramGetMessageQueueParamGetMessageQueueParamGetMessageQueueParam den Wert 2 (H_MSG_TRUE) zurück. Andernfalls wird eine Fehlerbehandlung durchgeführt.

Vorgänger

create_message_queuecreate_message_queueCreateMessageQueueCreateMessageQueueCreateMessageQueue, enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessage, dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage

Siehe auch

create_message_queuecreate_message_queueCreateMessageQueueCreateMessageQueueCreateMessageQueue, clear_message_queueclear_message_queueClearMessageQueueClearMessageQueueClearMessageQueue, enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessage, dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage, set_message_queue_paramset_message_queue_paramSetMessageQueueParamSetMessageQueueParamSetMessageQueueParam, create_messagecreate_messageCreateMessageCreateMessageCreateMessage, clear_messageclear_messageClearMessageClearMessageClearMessage, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTuple, get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTuple, set_message_objset_message_objSetMessageObjSetMessageObjSetMessageObj, get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObj

Modul

Foundation

Operatoren