AWS IoT Device SDK C: MQTT
MQTT 3.1.1 client library
Return to main page ↑
IotMqtt_strerror

Returns a string that describes an IotMqttError_t.

const char * IotMqtt_strerror( IotMqttError_t status );

Like the POSIX strerror, this function returns a string describing a return code. In this case, the return code is an MQTT library error code, status.

The string returned by this function MUST be treated as read-only: any attempt to modify its contents may result in a crash. Therefore, this function is limited to usage in logging.

Parameters
[in]statusThe status to describe.
Returns
A read-only string that describes status.
Warning
The string returned by this function must never be modified.