clear_messageclear_messageClearMessageClearMessage (Operator)

Name

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

Beschreibung

clear_messageclear_messageClearMessageClearMessageClearMessage schließt die Nachrichtenobjekte MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle, welche zuvor mit Hilfe des Operators create_messagecreate_messageCreateMessageCreateMessageCreateMessage oder dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage erzeugt wurden. Alle von den Nachrichten gehaltenen Ressourcen werden freigegeben, insbesondere die der gespeicherten Tupeldaten und ikonischen Objekte.

Nachdem die Nachrichten durch clear_messageclear_messageClearMessageClearMessageClearMessage 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.

Parameter

MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle (input_control) message(-array) → (integer)

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
* ...
clear_message (MessageHandles)

Ergebnis

clear_messageclear_messageClearMessageClearMessageClearMessage 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_messageClearMessageClearMessageClearMessage versuchen so viele Nachrichtenobjekte wie möglich frei zu geben, bevor ein Fehler zurückgegeben wird.