1.1.18.7.3 WDRV_WINC_MQTTUserPropCallbackSet

C

WDRV_WINC_STATUS WDRV_WINC_MQTTUserPropCallbackSet
(
    DRV_HANDLE handle,
    WDRV_WINC_MQTT_USER_PROP_CALLBACK pfUserPropCb
)

Description

Used to set the user property callback which will be called whenever a user property key/value pair are received.

Precondition

WDRV_WINC_Initialize must have been called.

WDRV_WINC_Open must have been called to obtain a valid handle.

WDRV_WINC_MQTTConnect must have been called to connect to a broker.

Parameters

ParametersDescription
handleClient handle obtained by a call to WDRV_WINC_Open.
pfUserPropCbPointer to callback function to call.

Returns

  • WDRV_WINC_STATUS_OK - Request was accepted.

  • WDRV_WINC_STATUS_NOT_OPEN - The driver instance is not open.

  • WDRV_WINC_STATUS_INVALID_ARG - The parameters were incorrect.

Remarks

None.