set_message_objT_set_message_objSetMessageObjSetMessageObjset_message_obj (Operator)

Name

set_message_objT_set_message_objSetMessageObjSetMessageObjset_message_obj — Hinzufügen eines Schlüssel-Objekt-Paares zu einem Nachrichtenobjekt.

Signatur

set_message_obj(ObjectData : : MessageHandle, Key : )

Herror T_set_message_obj(const Hobject ObjectData, const Htuple MessageHandle, const Htuple Key)

void SetMessageObj(const HObject& ObjectData, const HTuple& MessageHandle, const HTuple& Key)

void HMessage::SetMessageObj(const HObject& ObjectData, const HTuple& Key) const

void HMessage::SetMessageObj(const HObject& ObjectData, const HString& Key) const

void HMessage::SetMessageObj(const HObject& ObjectData, const char* Key) const

void HMessage::SetMessageObj(const HObject& ObjectData, const wchar_t* Key) const   (Nur Windows)

static void HOperatorSet.SetMessageObj(HObject objectData, HTuple messageHandle, HTuple key)

void HMessage.SetMessageObj(HObject objectData, HTuple key)

void HMessage.SetMessageObj(HObject objectData, string key)

def set_message_obj(object_data: HObject, message_handle: HHandle, key: Union[str, int]) -> None

Beschreibung

set_message_objset_message_objSetMessageObjSetMessageObjSetMessageObjset_message_obj speichert in einer Nachricht ähnlich zu einem assoziativem Array ein ikonisches Objekt in Verbindung mit einem Schlüssel ab. Das Nachrichtenobjekt wird im Parameter MessageHandleMessageHandleMessageHandleMessageHandlemessageHandlemessage_handle übergeben.

ObjectDataObjectDataObjectDataObjectDataobjectDataobject_data wird durch die Operation kopiert (vgl. copy_objcopy_objCopyObjCopyObjCopyObjcopy_obj) und kann daher anschließend ohne Seiteneffekte weiterverwendet oder gelöscht werden. Sowohl leere Objekte als auch ikonische Tupelobjekte sind zulässig und können von einem Schlüssel referenziert werden. Falls bereits Daten (Tupel oder Objekt) durch den gegebenen Schlüssel referenziert werden, werden die alten Daten freigegeben und durch ObjectDataObjectDataObjectDataObjectDataobjectDataobject_data ersetzt.

KeyKeyKeyKeykeykey ist ein String oder ein Integer, wobei bei Strings die Groß-/Kleinschreibung beachtet wird.

Die ikonischen Objekte für den übergebenen Schlüssel können mit Hilfe des Operators get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObjget_message_obj aus dem Nachrichtenobjekt wieder ausgelesen werden.

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

ObjectDataObjectDataObjectDataObjectDataobjectDataobject_data (input_object)  object(-array) objectHObjectHObjectHObjectHobject

Vom Schlüssel zu referenzierendes ikonisches Objekt.

MessageHandleMessageHandleMessageHandleMessageHandlemessageHandlemessage_handle (input_control, Zustand wird modifiziert)  message HMessage, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Nachrichtenobjekt.

Parameteranzahl: MessageHandle == 1

Restriktion: MessageHandle != 0

KeyKeyKeyKeykeykey (input_control)  string HTupleUnion[str, int]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Schlüsselwort oder Integer.

Parameteranzahl: Key == 1

Beispiel (HDevelop)

create_message (Message)
read_image( Image, 'filename')
set_message_obj (Image, Message, 'my_image')

Ergebnis

Im Erfolgsfall gibt set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTupleset_message_tuple den Wert TRUE zurück. Andernfalls wird eine Fehlerbehandlung durchgeführt. Mögliche Fehler sind ungültige Parameter (Nachrichtenobjekt oder Schlüssel) oder ein Allokierungsfehler.

Vorgänger

create_messagecreate_messageCreateMessageCreateMessageCreateMessagecreate_message

Nachfolger

enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessageenqueue_message, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTupleset_message_tuple

Alternativen

set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTupleset_message_tuple

Siehe auch

create_messagecreate_messageCreateMessageCreateMessageCreateMessagecreate_message, clear_messageclear_messageClearMessageClearMessageClearMessageclear_message, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTupleset_message_tuple, get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTupleget_message_tuple, 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