Unsubscribe

This method is used by the client to signal to the broker that no further messages with the specified topic should be transferred to it.
Syntax
METHOD Unsubscribe : BOOL
VAR_IN_OUT
sTopic : STRING; // topic string (UTF-8) with any length (attend that MQTT topics are case sensitive)
END_VAR
Return value
Name | Type | Description |
---|---|---|
Unsubscribe | BOOL | The method returns the return value TRUE if the call was successful. |
Inputs/outputs
Name | Type | Description |
---|---|---|
sTopic | STRING | Topic for which no further messages should be received. |
Possible errors are output at the outputs bError and hrErrorCode of the function block instance.