IotTaskPool_strerror

Returns a string that describes an IotTaskPoolError_t.

const char * IotTaskPool_strerror( IotTaskPoolError_t status );

Like the POSIX's strerror, this function returns a string describing a return code. In this case, the return code is a task pool 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]

status

The status to describe.

Returns

A read-only string that describes status.

Warning

The string returned by this function must never be modified.