clear_messageT_clear_messageClearMessageClearMessageclear_message (Operator)

Name

clear_messageT_clear_messageClearMessageClearMessageclear_message — Zerstören eins Nachrichtenobjektes und Freigeben aller Ressourcen.

Signatur

clear_message( : : MessageHandle : )

Beschreibung

clear_messageclear_messageClearMessageClearMessageClearMessageclear_message schließt die Nachrichtenobjekte MessageHandleMessageHandleMessageHandleMessageHandlemessageHandlemessage_handle, welche zuvor mit Hilfe des Operators create_messagecreate_messageCreateMessageCreateMessageCreateMessagecreate_message oder dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessagedequeue_message erzeugt wurden. Alle von den Nachrichten gehaltenen Ressourcen werden freigegeben, insbesondere die der gespeicherten Tupeldaten und ikonischen Objekte.

Achtung

Nachdem die Nachrichten durch clear_messageclear_messageClearMessageClearMessageClearMessageclear_message zerstört wurden dürfen sie nicht mehr verwendet werden. Die Verwendung von ungültigen Nachrichtenobjekte 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:

MessageHandleMessageHandleMessageHandleMessageHandlemessageHandlemessage_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

MessageHandleMessageHandleMessageHandleMessageHandlemessageHandlemessage_handle (input_control, Zustand wird modifiziert) message(-array) → (handle)

Zu zerstörende Nachrichtenobjekte.

Parameteranzahl: MessageHandle >= 1

Restriktion: MessageHandle != 0

Beispiel (HDevelop)

MessageHandles := []
for idx := 0 to 4 by 1
  create_message (MessageHandle)
  MessageHandles[idx]:= MessageHandle
endfor
* ...

Ergebnis

clear_messageclear_messageClearMessageClearMessageClearMessageclear_message gibt 2 (H_MSG_TRUE) zurück, wenn die übergebenen Nachrichtenobjekte gültig sind. Andernfalls wird eine Fehlerbehandlung durchgeführt. Falls ein Tupel von Nachrichtenobjekten übergeben wird welches ungültige Referenzen enthält, wird clear_messageclear_messageClearMessageClearMessageClearMessageclear_message versuchen so viele Nachrichtenobjekte wie möglich frei zu geben, bevor ein Fehler zurückgegeben wird.

Vorgänger

create_messagecreate_messageCreateMessageCreateMessageCreateMessagecreate_message, dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessagedequeue_message

Siehe auch

create_messagecreate_messageCreateMessageCreateMessageCreateMessagecreate_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, set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParamset_message_param, get_message_paramget_message_paramGetMessageParamGetMessageParamGetMessageParamget_message_param, enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessageenqueue_message, dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessagedequeue_message

Modul

Foundation

Operatoren