KlassenKlassenKlassenKlassen | | | | Operatoren

get_message_paramget_message_paramGetMessageParamget_message_paramGetMessageParamGetMessageParam (Operator)

Name

get_message_paramget_message_paramGetMessageParamget_message_paramGetMessageParamGetMessageParam — Abfragen von Parametern oder Information zu einer Nachricht.

Signatur

get_message_param( : : MessageHandle, GenParamName, Key : GenParamValue)

Herror get_message_param(const Hlong MessageHandle, const char* GenParamName, const char* Key, char* GenParamValue)

Herror T_get_message_param(const Htuple MessageHandle, const Htuple GenParamName, const Htuple Key, Htuple* GenParamValue)

Herror get_message_param(const HTuple& MessageHandle, const HTuple& GenParamName, const HTuple& Key, char* GenParamValue)

Herror get_message_param(const HTuple& MessageHandle, const HTuple& GenParamName, const HTuple& Key, HTuple* GenParamValue)

HTuple HMessage::GetMessageParam(const HTuple& GenParamName, const HTuple& Key) const

void GetMessageParam(const HTuple& MessageHandle, const HTuple& GenParamName, const HTuple& Key, HTuple* GenParamValue)

HTuple HMessage::GetMessageParam(const HString& GenParamName, const HTuple& Key) const

HTuple HMessage::GetMessageParam(const HString& GenParamName, const HString& Key) const

HTuple HMessage::GetMessageParam(const char* GenParamName, const char* Key) const

void HOperatorSetX.GetMessageParam(
[in] VARIANT MessageHandle, [in] VARIANT GenParamName, [in] VARIANT Key, [out] VARIANT* GenParamValue)

VARIANT HMessageX.GetMessageParam(
[in] BSTR GenParamName, [in] VARIANT Key)

static void HOperatorSet.GetMessageParam(HTuple messageHandle, HTuple genParamName, HTuple key, out HTuple genParamValue)

HTuple HMessage.GetMessageParam(string genParamName, HTuple key)

HTuple HMessage.GetMessageParam(string genParamName, string key)

Beschreibung

get_message_paramget_message_paramGetMessageParamget_message_paramGetMessageParamGetMessageParam fragt die aktuellen Werte der Parameter einer Nachricht oder anderweitige Informationen zum Status einer Nachricht ab.

Jeder Aufruf von get_message_paramget_message_paramGetMessageParamget_message_paramGetMessageParamGetMessageParam darf nur einen einzelnen Parameternamen in GenParamNameGenParamNameGenParamNameGenParamNameGenParamNamegenParamName enthalten. Es gibt zwei unterschiedliche Arten von Abfragen:

Parameternamen, die unabhängig von Schlüsseln angewendet werden:

'message_keys'"message_keys""message_keys""message_keys""message_keys""message_keys":

Fragt alle Schlüsselwörter ab, die in einer Nachricht gespeichert sind, unabhängig von dem Typ der mit ihnen verbundenen Daten. Die Liste der Schlüssel wird über den Parameter GenParamValueGenParamValueGenParamValueGenParamValueGenParamValuegenParamValue als ein Tupel von Strings zurückgegeben. Für diese Abfrage muss dem Parameter KeyKeyKeyKeyKeykey ein leeres Tupel übergeben werden.

Parametername, die Schlüssel-spezifisch angewendet werden:

'key_exists'"key_exists""key_exists""key_exists""key_exists""key_exists":

Gibt 1 zurück, wenn der übergebenen Schlüssel in der spezifizierten Nachricht gespeichert ist, sonst 0. Die Ergebnisse werden im Parameter GenParamValueGenParamValueGenParamValueGenParamValueGenParamValuegenParamValue zurückgegeben, jeweils ein Wert pro übergebenem Schlüsselwort.

'key_data_type'"key_data_type""key_data_type""key_data_type""key_data_type""key_data_type":

Gibt den Wert 'tuple'"tuple""tuple""tuple""tuple""tuple" für Schlüssel zurück, die in der Nachricht Tupeldaten referenzieren. Die Tupeldaten selbst erhält man mit dem Operator get_message_tupleget_message_tupleGetMessageTupleget_message_tupleGetMessageTupleGetMessageTuple. Der Wert 'object'"object""object""object""object""object" wird für Schlüssel zurückgegeben, welche Objektdaten referenzieren. Die Objektdaten selbst werden vom Operator get_message_objget_message_objGetMessageObjget_message_objGetMessageObjGetMessageObj zurückgegeben. Die Ergebnisse werden im Parameter GenParamValueGenParamValueGenParamValueGenParamValueGenParamValuegenParamValue zurückgegeben, jeweils ein Wert pro Schlüsselwort. Dieser Parameter kann verwendet werden um dynamisch zu entscheiden, ob get_message_tupleget_message_tupleGetMessageTupleget_message_tupleGetMessageTupleGetMessageTuple oder get_message_objget_message_objGetMessageObjget_message_objGetMessageObjGetMessageObj verwendet werden muss um die Daten eines speziellen Schlüssels zu erhalten.

Parallelisierung

Parameter

MessageHandleMessageHandleMessageHandleMessageHandleMessageHandlemessageHandle (input_control)  message HMessage, HTupleHTupleHMessage, HTupleHMessageX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Nachrichtenobjekt.

Parameteranzahl: MessageHandle == 1

Restriktion: MessageHandle != 0

GenParamNameGenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name des Parameters.

Parameteranzahl: GenParamName == GenParamValue

Defaultwert: 'message_keys' "message_keys" "message_keys" "message_keys" "message_keys" "message_keys"

Werteliste: 'key_data_type'"key_data_type""key_data_type""key_data_type""key_data_type""key_data_type", 'key_exists'"key_exists""key_exists""key_exists""key_exists""key_exists", 'message_keys'"message_keys""message_keys""message_keys""message_keys""message_keys"

KeyKeyKeyKeyKeykey (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Schlüsselwort auf das der Parameter angewendet werden soll.

Restriktion: length(Key) > 0

GenParamValueGenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  tuple(-array) HTupleHTupleHTupleVARIANTHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double) (BSTR / Hlong / double) (char* / Hlong / double)

Wert der Parameterabfrage.

Beispiel (HDevelop)

get_message_param (Message, 'message_keys', [], AllKeys)
get_message_param (Message, 'key_data_type', AllKeys, KeysType)

Ergebnis

Wenn alle Parameter und übergebenen Schlüsselwörter gültig sind, gib get_message_paramget_message_paramGetMessageParamget_message_paramGetMessageParamGetMessageParam den Wert 2 (H_MSG_TRUE) zurück. Andernfalls wird eine Fehlerbehandlung durchgeführt.

Vorgänger

dequeue_messagedequeue_messageDequeueMessagedequeue_messageDequeueMessageDequeueMessage

Siehe auch

create_messagecreate_messageCreateMessagecreate_messageCreateMessageCreateMessage, clear_messageclear_messageClearMessageclear_messageClearMessageClearMessage, set_message_tupleset_message_tupleSetMessageTupleset_message_tupleSetMessageTupleSetMessageTuple, get_message_tupleget_message_tupleGetMessageTupleget_message_tupleGetMessageTupleGetMessageTuple, set_message_objset_message_objSetMessageObjset_message_objSetMessageObjSetMessageObj, get_message_objget_message_objGetMessageObjget_message_objGetMessageObjGetMessageObj, set_message_paramset_message_paramSetMessageParamset_message_paramSetMessageParamSetMessageParam, enqueue_messageenqueue_messageEnqueueMessageenqueue_messageEnqueueMessageEnqueueMessage, dequeue_messagedequeue_messageDequeueMessagedequeue_messageDequeueMessageDequeueMessage

Modul

Foundation


KlassenKlassenKlassenKlassen | | | | Operatoren