AwsIotShadow_DeleteSync

Delete a Thing Shadow with a timeout.

AwsIotShadowError_t AwsIotShadow_DeleteSync( IotMqttConnection_t mqttConnection,
                                             const char * pThingName,
                                             size_t thingNameLength,
                                             uint32_t flags,
                                             uint32_t timeoutMs );

This function queues a Shadow delete, then waits for the result. Internally, this function is a call to AwsIotShadow_DeleteAsync followed by AwsIotShadow_Wait. See AwsIotShadow_DeleteAsync for more information on the Shadow delete operation.

Parameters

[in]	mqttConnection	The MQTT connection to use for Shadow delete.
[in]	pThingName	The Thing Name associated with the Shadow to delete.
[in]	thingNameLength	The length of pThingName.
[in]	flags	Flags which modify the behavior of this function. See Shadow Function Flags.
[in]	timeoutMs	If the Shadow service does not respond to the Shadow delete within this timeout, this function returns AWS_IOT_SHADOW_TIMEOUT.

Returns

One of the following:

• AWS_IOT_SHADOW_SUCCESS
• AWS_IOT_SHADOW_NOT_INITIALIZED
• AWS_IOT_SHADOW_BAD_PARAMETER
• AWS_IOT_SHADOW_NO_MEMORY
• AWS_IOT_SHADOW_MQTT_ERROR
• AWS_IOT_SHADOW_BAD_RESPONSE
• AWS_IOT_SHADOW_TIMEOUT
• A Shadow service rejection reason between 400 (AWS_IOT_SHADOW_BAD_REQUEST) and 500 (AWS_IOT_SHADOW_SERVER_ERROR)