.. first line of object.rst template
.. first line of pou-object.rst template
.. first line of fun-object.rst template
.. _`.fld-FinderOpta.fld-Functions.fld-Send.MQTT_SendTopicString`:


.. index::
   single: MQTT_SendTopicString

.. _`MQTT_SendTopicString`:

``MQTT_SendTopicString`` (FUN)
------------------------------

FUNCTION MQTT_SendTopicString : WORD




This function publishes a string value to the specified MQTT topic.

The output ``sent`` is set to ``TRUE`` when the publish operation has been
completed.





InOut:
    +--------+--------------------------+-----------------+------------------------------------------------------------+
    | Scope  | Name                     | Type            | Comment                                                    |
    +========+==========================+=================+============================================================+
    | Return | ``MQTT_SendTopicString`` | ``WORD``        | Status code returned by the runtime (0 means "no errors"). |
    +--------+--------------------------+-----------------+------------------------------------------------------------+
    | Inout  | ``id``                   | ``WORD``        | Operation identifier used by the runtime.                  |
    +--------+--------------------------+-----------------+------------------------------------------------------------+
    | Input  | ``topic``                | ``STRING(127)`` | MQTT topic name.                                           |
    +        +--------------------------+-----------------+------------------------------------------------------------+
    |        | ``payload``              | ``STRING(244)`` | String value to publish.                                   |
    +        +--------------------------+-----------------+------------------------------------------------------------+
    |        | ``qos``                  | ``WORD``        | Quality of Service level.                                  |
    +        +--------------------------+-----------------+------------------------------------------------------------+
    |        | ``flags``                | ``WORD``        | Publish options: 0-none, 1-retain.                         |
    +--------+--------------------------+-----------------+------------------------------------------------------------+
    | Output | ``sent``                 | ``BOOL``        | ``TRUE`` when the publish operation has been completed.    |
    +--------+--------------------------+-----------------+------------------------------------------------------------+







.. last line of fun-object.rst template
.. last line of pou-object.rst template
.. last line of object.rst template



