IOTHUB_CLIENT_PROPERTY_PARSED Struct Reference

This struct represents a property from IoT Hub.
It is generated by IoTHubClient_Deserialize_Properties() while deserializing a property payload. More...

#include <iothub_client_properties.h>

Data Fields
int	structVersion
	Version of the structure. Currently must be IOTHUB_CLIENT_PROPERTY_PARSED_STRUCT_VERSION_1.
IOTHUB_CLIENT_PROPERTY_TYPE	propertyType
	Whether this is a property the client reported (and we're seeing what IoT Hub last received from the client) or whether it's a writable property request from the client.
const char *	componentName
	Name of the component. Optional; may be NULL for the root component.
const char *	name
	Name of the property.
IOTHUB_CLIENT_PROPERTY_VALUE_TYPE	valueType
	Whether the value is passed as a string or non-null terminated length. More...
union {
const char *   str
}	value
	Value of the property. Currently this is only set to str.
size_t	valueLength
	Number of bytes in valueLength. Does not include null-terminator if IOTHUB_CLIENT_PROPERTY_VALUE_STRING is set.

Detailed Description

This struct represents a property from IoT Hub.
It is generated by IoTHubClient_Deserialize_Properties() while deserializing a property payload.

Field Documentation

valueType

IOTHUB_CLIENT_PROPERTY_VALUE_TYPE IOTHUB_CLIENT_PROPERTY_PARSED::valueType

Whether the value is passed as a string or non-null terminated length.

@description Applications can safely assume that this will always be IOTHUB_CLIENT_PROPERTY_VALUE_STRING.
Additional types may be added in the future but they will never be the default.

---

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

• iothub_client_properties.h