SendCustomDeviceIcon

SendCustomDeviceIcon 1:

Diese Methode ermöglicht es dem Benutzer, ein benutzerdefiniertes Icon zu senden, das auf der obersten Ebene eines Communicator-Bausteins angezeigt wird. Standardmäßig wird an dieser Stelle der TwinCAT-Würfel dargestellt. Das Icon wird als Base64-codierter String übertragen und kann auch zur Laufzeit geändert werden.

Bitte beachten Sie, dass je nach Bildgröße große Datenmengen übertragen werden können. Sowohl in der SPS, im Message Broker als auch in der App wird entsprechend mehr Speicherplatz benötigt. Bei statischen Bildern empfiehlt es sich daher, das Icon nur einmalig beim Programmstart zu übertragen. Durch die Speicherung im Retain-Topic bleibt das Bild für alle nachfolgenden Clients dauerhaft verfügbar.

Syntax

METHOD SendCustomDeviceIcon : BOOL
VAR_INPUT
    pBase64EncodedIconString : POINTER TO STRING;
    bIsIconMulticolor        : BOOL;
END_VAR

SendCustomDeviceIcon 2: Rückgabewert

Name

Typ

Beschreibung

SendCustomDeviceIcon

BOOL

Bei erfolgreichem Aufruf liefert die Methode den Rückgabewert TRUE.

SendCustomDeviceIcon 3: Eingänge

Name

Typ

Beschreibung

pBase64EncodedIconString

POINTER TO STRING

Pointer zu dem Base64-String, der das Bild enthält. Das Bild muss mithilfe von einem Konverter von einem Bildformat in einen Base64-String umgewandelt werden. Hier ist zu beachten, dass nur der Base64-String angegeben wird.

bIsIconMulticolor

BOOL

Wird bei mehrfarbigen Icons auf TRUE gesetzt und sorgt dafür, dass die Farben nicht invertiert werden, wenn die App im Dark Mode betrieben wird. Wenn diese Einstellung auf FALSE gesetzt wird, wird das Icon in jedem Fall in den Farben schwarz und weiß dargestellt.

Mögliche Fehler werden an den Ausgängen bError und hrErrorCode der Bausteininstanz ausgegeben.