This struct represents the response to a writable property that the client will return.
This structure is filled out by the application and can be serialized into a payload for IoT Hub via IoTHubClient_Properties_Serializer_CreateWritableResponse(). More...

#include <iothub_client_properties.h>

Data Fields
int	structVersion
	Version of the structure. Currently must be IOTHUB_CLIENT_PROPERTY_WRITABLE_RESPONSE_STRUCT_VERSION_1.

const char *	name
	Name of the property.

const char *	value
	Value of the property. This must be legal JSON. Strings need to be escaped by the application, e.g. writeableResponse.value="\"MyValue"";.

int	result
	Result of the requested operation. This maps to an HTTP status code.

int	ackVersion
	Acknowledgement version. This corresponds to the version of the writable properties being responded to. More...

const char *	description
	Optional friendly description of the operation. May be NULL.

Detailed Description

This struct represents the response to a writable property that the client will return.
This structure is filled out by the application and can be serialized into a payload for IoT Hub via IoTHubClient_Properties_Serializer_CreateWritableResponse().

Field Documentation

◆ ackVersion

int IOTHUB_CLIENT_PROPERTY_WRITABLE_RESPONSE::ackVersion

Acknowledgement version. This corresponds to the version of the writable properties being responded to.

If using IoTHubClient_Properties_Deserializer_Create() to deserialize initial property request from IoT Hub, just set this field to what was returned by IoTHubClient_Properties_Deserializer_GetVersion().

The documentation for this struct was generated from the following file:

iothub_client_properties.h

Data Fields

Detailed Description

Field Documentation

◆ ackVersion