1.1.18.17 WDRV_WINC_MQTTUnsubscribe

C

WDRV_WINC_STATUS WDRV_WINC_MQTTUnsubscribe
(
    DRV_HANDLE handle,
    const char* pTopicName
)

Description

Sends a request to un-subscribe from an MQTT topic.

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.
pTopicNamePointer to topic name to un-subscribe from.

Returns

  • WDRV_WINC_STATUS_OK - An unsubscribe was sent.

  • WDRV_WINC_STATUS_NOT_OPEN - The driver instance is not open.

  • WDRV_WINC_STATUS_REQUEST_ERROR - The request to the WINC was rejected.

  • WDRV_WINC_STATUS_INVALID_ARG - The parameters were incorrect.

Remarks

None.