Paulo Roman / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BLE_API by Bluetooth Low Energy

Diff: public/DiscoveredCharacteristic.h

Revision:
473:d10415d0a07d
Parent:
472:2a040d99104c
Child:
475:eb7fbcfb0e85
--- a/public/DiscoveredCharacteristic.h	Fri Jun 19 15:51:59 2015 +0100
+++ b/public/DiscoveredCharacteristic.h	Fri Jun 19 15:51:59 2015 +0100
@@ -75,6 +75,10 @@
      * given offset. If the Characteristic or Descriptor to be read is longer
      * than ATT_MTU - 1, this function must be called multiple times with
      * appropriate offset to read the complete value.
+     *
+     * @return BLE_ERROR_NONE if a read has been initiated, else
+     *         BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
+     *         BLE_STACK_BUSY if some client procedure already in progress.
      */
     virtual ble_error_t read(uint16_t offset = 0) = 0;