Diff: iothub_message.h

Revision:

92:97148cf9aa2a

Parent:

89:a2ed767a532e

--- a/iothub_message.h	Thu Jul 12 18:09:13 2018 -0700
+++ b/iothub_message.h	Tue Sep 11 11:13:11 2018 -0700
@@ -2,7 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 /** @file   iothub_message.h
-*	@brief  The @c IoTHub_Message component encapsulates one message that
+*    @brief  The @c IoTHub_Message component encapsulates one message that
 *           can be transferred by an IoT hub client.
 */
 
@@ -10,7 +10,7 @@
 #define IOTHUB_MESSAGE_H
 
 #include "azure_c_shared_utility/macro_utils.h"
-#include "azure_c_shared_utility/map.h" 
+#include "azure_c_shared_utility/map.h"
 #include "azure_c_shared_utility/umock_c_prod.h"
 
 #ifdef __cplusplus
@@ -170,7 +170,9 @@
 MOCKABLE_FUNCTION(, const char*, IoTHubMessage_GetContentEncodingSystemProperty, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle);
 
 /**
+** DEPRECATED: Use IoTHubMessage_SetProperty and IoTHubMessage_GetProperty instead. **
 * @brief   Gets a handle to the message's properties map.
+*          Note that when sending messages via the HTTP transport, the key names in the map must not contain spaces.
 *
 * @param   iotHubMessageHandle Handle to the message.
 *
@@ -183,7 +185,7 @@
 *
 * @param   iotHubMessageHandle Handle to the message.
 *
-* @param   key name of the property to set.
+* @param   key name of the property to set.  Note that when sending messages via the HTTP transport, this value must not contain spaces.
 *
 * @param   value of the property to set.
 *