1.1.18.4.5 WDRV_WINC_MQTTMsgInfoRetainSet

C

WDRV_WINC_STATUS WDRV_WINC_MQTTMsgInfoRetainSet
(
    WDRV_WINC_MQTT_MSG_INFO *pMsgInfo,
    bool retain
)

Description

Sets the retain property of a message info structure.

Precondition

WDRV_WINC_MQTTMsgInfoDefaultSet must have been called.

Parameters

ParametersDescription
pMsgInfoPointer to message info structure.
retainFlag indicating if message is to be retained.

Returns

  • WDRV_WINC_STATUS_OK - Request was accepted.

  • WDRV_WINC_STATUS_INVALID_ARG - The parameters were incorrect.

Remarks

None.