clear_message_queueT_clear_message_queueClearMessageQueueClearMessageQueueclear_message_queue (Operator)

Name

clear_message_queueT_clear_message_queueClearMessageQueueClearMessageQueueclear_message_queue — Schließen einer Warteschlange für Nachrichten.

Signatur

clear_message_queue( : : QueueHandle : )

Beschreibung

clear_message_queueclear_message_queueClearMessageQueueClearMessageQueueClearMessageQueueclear_message_queue schließt ein Warteschlangenobjekt QueueHandleQueueHandleQueueHandleQueueHandlequeueHandlequeue_handle, dass zuvor durch den Operator create_message_queuecreate_message_queueCreateMessageQueueCreateMessageQueueCreateMessageQueuecreate_message_queue erzeugt wurde. Es werden alle Ressourcen freigegeben, die von der Warteschlange gehalten werden, einschließlich der eingereihten Nachrichtenobjekte und der in ihnen enthaltenen Datensätze.

Achtung

Nachdem die Warteschlangenobjekte durch clear_message_queueclear_message_queueClearMessageQueueClearMessageQueueClearMessageQueueclear_message_queue zerstört wurden dürfen sie nicht mehr verwendet werden. Die Verwendung von ungültigen Referenzen führt zu undefiniertem Verhalten. Der Operator clear_message_queueclear_message_queueClearMessageQueueClearMessageQueueClearMessageQueueclear_message_queue darf nicht auf ein Warteschlangenobjekt aufgerufen werden, dass gleichzeitig noch in einem anderen Thread in Verwendung ist. Dies führt zu undefiniertem Verhalten.

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.

Dieser Operator modifiziert den Zustand des folgenden Eingabeparameters:

QueueHandleQueueHandleQueueHandleQueueHandlequeueHandlequeue_handle

Während der Ausführung dieses Operators muss der Zugriff auf den Wert dieses Parameters synchronisiert werden, wenn er über mehrere Threads hinweg verwendet wird.

Parameter

QueueHandleQueueHandleQueueHandleQueueHandlequeueHandlequeue_handle (input_control, Zustand wird modifiziert) message_queue(-array) → (handle)

Freizugebene Warteschlangenobjekt(e).

Parameteranzahl: QueueHandle >= 1

Restriktion: QueueHandle != 0

Beispiel (HDevelop)

create_message_queue (ProducerQueue)
create_message_queue (ResultQueue)
* ...

Ergebnis

clear_message_queueclear_message_queueClearMessageQueueClearMessageQueueClearMessageQueueclear_message_queue gibt den Wert 2 (H_MSG_TRUE) zurück, wenn die übergebenen Warteschlangenobjekte gültig sind. Andernfalls wird eine Fehlerbehandlung durchgeführt. Sollte eine der übergebenen Referenzen ungültig sein, wird clear_message_queueclear_message_queueClearMessageQueueClearMessageQueueClearMessageQueueclear_message_queue dennoch versuchen alle anderen Referenzen freizugeben bevor es den Fehler zurück gibt.

Vorgänger

create_message_queuecreate_message_queueCreateMessageQueueCreateMessageQueueCreateMessageQueuecreate_message_queue, set_message_queue_paramset_message_queue_paramSetMessageQueueParamSetMessageQueueParamSetMessageQueueParamset_message_queue_param

Siehe auch

create_message_queuecreate_message_queueCreateMessageQueueCreateMessageQueueCreateMessageQueuecreate_message_queue, enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessageenqueue_message, dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessagedequeue_message, set_message_queue_paramset_message_queue_paramSetMessageQueueParamSetMessageQueueParamSetMessageQueueParamset_message_queue_param, get_message_queue_paramget_message_queue_paramGetMessageQueueParamGetMessageQueueParamGetMessageQueueParamget_message_queue_param, create_messagecreate_messageCreateMessageCreateMessageCreateMessagecreate_message, clear_messageclear_messageClearMessageClearMessageClearMessageclear_message, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTupleset_message_tuple, get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTupleget_message_tuple, set_message_objset_message_objSetMessageObjSetMessageObjSetMessageObjset_message_obj, get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObjget_message_obj

Modul

Foundation

Operatoren