KlassenKlassenKlassenKlassen | | | | Operatoren

get_message_queue_paramget_message_queue_paramGetMessageQueueParamget_message_queue_paramGetMessageQueueParamGetMessageQueueParam (Operator)

Name

get_message_queue_paramget_message_queue_paramGetMessageQueueParamget_message_queue_paramGetMessageQueueParamGetMessageQueueParam — Abfragen der Parameter einer Warteschlange für Nachrichten.

Signatur

get_message_queue_param( : : QueueHandle, GenParamName : GenParamValue)

Herror get_message_queue_param(const Hlong QueueHandle, const char* GenParamName, char* GenParamValue)

Herror T_get_message_queue_param(const Htuple QueueHandle, const Htuple GenParamName, Htuple* GenParamValue)

Herror get_message_queue_param(const HTuple& QueueHandle, const HTuple& GenParamName, char* GenParamValue)

Herror get_message_queue_param(const HTuple& QueueHandle, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HMessageQueue::GetMessageQueueParam(const HTuple& GenParamName) const

void GetMessageQueueParam(const HTuple& QueueHandle, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HMessageQueue::GetMessageQueueParam(const HTuple& GenParamName) const

HTuple HMessageQueue::GetMessageQueueParam(const HString& GenParamName) const

HTuple HMessageQueue::GetMessageQueueParam(const char* GenParamName) const

void HOperatorSetX.GetMessageQueueParam(
[in] VARIANT QueueHandle, [in] VARIANT GenParamName, [out] VARIANT* GenParamValue)

VARIANT HMessageQueueX.GetMessageQueueParam([in] VARIANT GenParamName)

static void HOperatorSet.GetMessageQueueParam(HTuple queueHandle, HTuple genParamName, out HTuple genParamValue)

HTuple HMessageQueue.GetMessageQueueParam(HTuple genParamName)

HTuple HMessageQueue.GetMessageQueueParam(string genParamName)

Beschreibung

get_message_queue_paramget_message_queue_paramGetMessageQueueParamget_message_queue_paramGetMessageQueueParamGetMessageQueueParam fragt die aktuellen Werte der Parameter einer Warteschlange oder Informationen zu ihrem Status ab.

Es können mit einem einzelnen Aufruf von get_message_queue_paramget_message_queue_paramGetMessageQueueParamget_message_queue_paramGetMessageQueueParamGetMessageQueueParam mehrere Werte abgefragt werden, indem GenParamNameGenParamNameGenParamNameGenParamNameGenParamNamegenParamName mehrere Parameternamen übergeben werden. Die Parameterwerte werden in GenParamValueGenParamValueGenParamValueGenParamValueGenParamValuegenParamValue in korrespondierender Reihenfolge zu den Parameternamen zurückgegeben.

Es werden folgende Parameternamen unterstützt:

'is_empty'"is_empty""is_empty""is_empty""is_empty""is_empty":

Gibt den Wert 1 zurück, wenn die Warteschlange leer ist, sonst 0.

'message_num'"message_num""message_num""message_num""message_num""message_num":

Gibt die Anzahl der Nachrichten zurück, die aktuell in der Warteschlange eingereiht sind.

'max_message_num'"max_message_num""max_message_num""max_message_num""max_message_num""max_message_num":

Gibt den aktuellen Wert für die maximale Anzahl von Nachrichten zurück, die in einer Warteschlange eingereiht werden können. Dieser Wert kann mit set_message_queue_paramset_message_queue_paramSetMessageQueueParamset_message_queue_paramSetMessageQueueParamSetMessageQueueParam eingestellt werden. Die Voreinstellung -1 bedeutet, dass eine unbegrenzte Anzahl von Nachrichten eingereiht werden kann.

Parallelisierung

Parameter

QueueHandleQueueHandleQueueHandleQueueHandleQueueHandlequeueHandle (input_control)  message_queue HMessageQueue, HTupleHTupleHMessageQueue, HTupleHMessageQueueX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Warteschlangenobjekt.

Parameteranzahl: QueueHandle == 1

Restriktion: QueueHandle != 0

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

Parameternamen.

Parameteranzahl: GenParamName == GenParamValue

Defaultwert: 'max_message_num' "max_message_num" "max_message_num" "max_message_num" "max_message_num" "max_message_num"

Werteliste: 'is_empty'"is_empty""is_empty""is_empty""is_empty""is_empty", 'max_message_num'"max_message_num""max_message_num""max_message_num""max_message_num""max_message_num", 'message_num'"message_num""message_num""message_num""message_num""message_num"

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)

Abgefragte Parameterwerte.

Parameteranzahl: GenParamName == GenParamValue

Beispiel (HDevelop)

create_message_queue (QueueHandle)
set_message_queue_param ( QueueHandle, 'max_message_num', 10)
* ...
get_message_queue_param( QueueHandle, 'message_num', Num)

Ergebnis

Wenn alle Parameter gültig sind liefert get_message_queue_paramget_message_queue_paramGetMessageQueueParamget_message_queue_paramGetMessageQueueParamGetMessageQueueParam den Wert 2 (H_MSG_TRUE) zurück. Andernfalls wird eine Fehlerbehandlung durchgeführt.

Vorgänger

create_message_queuecreate_message_queueCreateMessageQueuecreate_message_queueCreateMessageQueueCreateMessageQueue, enqueue_messageenqueue_messageEnqueueMessageenqueue_messageEnqueueMessageEnqueueMessage, dequeue_messagedequeue_messageDequeueMessagedequeue_messageDequeueMessageDequeueMessage

Siehe auch

create_message_queuecreate_message_queueCreateMessageQueuecreate_message_queueCreateMessageQueueCreateMessageQueue, clear_message_queueclear_message_queueClearMessageQueueclear_message_queueClearMessageQueueClearMessageQueue, enqueue_messageenqueue_messageEnqueueMessageenqueue_messageEnqueueMessageEnqueueMessage, dequeue_messagedequeue_messageDequeueMessagedequeue_messageDequeueMessageDequeueMessage, set_message_queue_paramset_message_queue_paramSetMessageQueueParamset_message_queue_paramSetMessageQueueParamSetMessageQueueParam, 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

Modul

Foundation


KlassenKlassenKlassenKlassen | | | | Operatoren