FB_IotMqtt5UserProperties

Der Funktionsbaustein ermöglicht die Definition und die Handhabung von UserProperties. UserProperties sind Key/Value-Paare, welche optionale Metadaten beschreiben und zum Beispiel bei PublishProperties Verwendung finden können.

	Anzahl der UserProperties Die Verarbeitung von UserProperties im SPS Echtzeit-Task-Zyklus bedarf ja nach Menge einer gewissen Zeitdauer, weshalb diese besser gering zu halten ist. Die Menge der maximal möglichen UserProperties lässt sich über den Paramater `cMaxMqtt5UserProps` in der Parameterliste der Bibliothek Tc3_IotBase einstellen.

Syntax

Definition:

FUNCTION_BLOCK FB_IotMqtt5UserProperties 
VAR_OUTPUT
    bError           : BOOL;
    hrErrorCode      : HRESULT;
END_VAR

Ausgänge

Name	Typ	Beschreibung
bError	BOOL	Wird TRUE, sobald eine Fehlersituation eintritt.
hrErrorCode	HRESULT	Liefert bei einem gesetzten bError-Ausgang einen Fehlercode. Eine Erläuterung zu den möglichen Fehlercodes befindet sich im Anhang.

Eigenschaften

Name	Typ	Zugriff	Beschreibung
nUserPropertyCnt	UINT	Get	Gibt die Anzahl der enthaltenen UserProperties an.

Methoden

Name	Beschreibung
AddUserProperty	Fügt ein UserProperty zur Liste hinzu. Das Property wird hierbei durch dessen Name und Value spezifiziert.
ClearUserProperties	Löscht alle in der Liste enthaltenen UserProperties.
GetUserPropertyByIdx	Gibt den Namen und Wert eines UserProperty zurück, welches durch dessen Position (Index) in der Liste angegeben wird.
GetUserPropertyValueByName	Gibt den Wert eines UserProperty zurück, welches durch dessen Namen angegeben wird.
SetUserProperties	Löscht alle in der Liste enthaltenen UserProperties und fügt eine Menge von UserProperties hinzu, welche durch ein Array von Objekten vom Typ MqttUserProperty angegeben werden.

Voraussetzungen

Entwicklungsumgebung	Zielplattform	Einzubindende SPS-Bibliotheken
TwinCAT v3.1.4026.0	IPC oder CX (x86, x64, ARM)	Tc3_IotBase (>= v3.4.2.0)