clear_messageT_clear_messageClearMessageClearMessageclear_message (Operator)

Name

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

Signatur

clear_message( : : MessageHandle : )

Herror T_clear_message(const Htuple MessageHandle)

void ClearMessage(const HTuple& MessageHandle)

static void HMessage::ClearMessage(const HMessageArray& MessageHandle)

void HMessage::ClearMessage() const

static void HOperatorSet.ClearMessage(HTuple messageHandle)

static void HMessage.ClearMessage(HMessage[] messageHandle)

void HMessage.ClearMessage()

def clear_message(message_handle: MaybeSequence[HHandle]) -> None

Beschreibung

clear_messageclear_messageClearMessageClearMessageclear_message schließt die Nachrichtenobjekte MessageHandleMessageHandleMessageHandlemessageHandlemessage_handle, welche zuvor mit Hilfe des Operators create_messagecreate_messageCreateMessageCreateMessagecreate_message oder dequeue_messagedequeue_messageDequeueMessageDequeueMessagedequeue_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_messageClearMessageClearMessageclear_message zerstört wurden dürfen sie nicht mehr verwendet werden. Die Verwendung von ungültigen Nachrichtenobjekte führt zu undefiniertem Verhalten.

Ausführungsinformationen

Dieser Operator modifiziert den Zustand des folgenden Eingabeparameters:

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

MessageHandleMessageHandleMessageHandlemessageHandlemessage_handle (input_control, Zustand wird modifiziert)  message(-array) HMessage, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (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_messageClearMessageClearMessageclear_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_messageClearMessageClearMessageclear_message versuchen so viele Nachrichtenobjekte wie möglich frei zu geben, bevor ein Fehler zurückgegeben wird.

Vorgänger

create_messagecreate_messageCreateMessageCreateMessagecreate_message, dequeue_messagedequeue_messageDequeueMessageDequeueMessagedequeue_message

Siehe auch

create_messagecreate_messageCreateMessageCreateMessagecreate_message, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleset_message_tuple, get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleget_message_tuple, set_message_objset_message_objSetMessageObjSetMessageObjset_message_obj, get_message_objget_message_objGetMessageObjGetMessageObjget_message_obj, set_message_paramset_message_paramSetMessageParamSetMessageParamset_message_param, get_message_paramget_message_paramGetMessageParamGetMessageParamget_message_param, enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageenqueue_message, dequeue_messagedequeue_messageDequeueMessageDequeueMessagedequeue_message

Modul

Foundation