Diff: ble/Gap.h

Revision:

1098:5f6b5ea5d5f2

Parent:

1096:c3a43f09f1c5

Child:

1099:6c54ccecf1e8

diff -r 4d22814faf46 -r 5f6b5ea5d5f2 ble/Gap.h
--- a/ble/Gap.h	Mon Jan 11 08:51:53 2016 +0000
+++ b/ble/Gap.h	Mon Jan 11 08:51:53 2016 +0000
@@ -620,7 +620,8 @@
 
     /**
      * Update a particular ADV field in the advertising payload (based on
-     * matching type).
+     * matching type and length). Note: the length of the new data must be the
+     * same as the old one.
      *
      * @param[in] type  The ADV type field describing the variable length data.
      * @param[in] data  Data bytes.
@@ -629,7 +630,7 @@
      * @note: If advertisements are enabled, then the update will take effect immediately.
      *
      * @return BLE_ERROR_NONE if the advertisement payload was updated based on
-     *         matching AD type; otherwise, an appropriate error.
+     *         a <type, len> match; otherwise, an appropriate error.
      */
     ble_error_t updateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
         if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {