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.
Dependencies: BLE_API mbed-dev-bin nRF51822
Fork of microbit-dal by
Diff: inc/drivers/MicroBitSerial.h
- Revision:
- 67:99cfde195ff3
- Parent:
- 66:2fc7d7c2fffc
--- a/inc/drivers/MicroBitSerial.h Wed Jul 13 12:18:46 2016 +0100
+++ b/inc/drivers/MicroBitSerial.h Wed Jul 13 12:18:47 2016 +0100
@@ -265,8 +265,9 @@
*
* Defaults to SYNC_SLEEP.
*
- * @return the number of bytes written, or MICROBIT_SERIAL_IN_USE if another fiber
- * is using the serial instance for transmission.
+ * @return the number of bytes written, MICROBIT_SERIAL_IN_USE if another fiber
+ * is using the serial instance for transmission, MICROBIT_INVALID_PARAMETER
+ * if buffer is invalid, or the given bufferLen is <= 0.
*/
int send(ManagedString s, MicroBitSerialMode mode = MICROBIT_DEFAULT_SERIAL_MODE);
@@ -292,8 +293,9 @@
*
* Defaults to SYNC_SLEEP.
*
- * @return the number of bytes written, or MICROBIT_SERIAL_IN_USE if another fiber
- * is using the serial instance for transmission.
+ * @return the number of bytes written, MICROBIT_SERIAL_IN_USE if another fiber
+ * is using the serial instance for transmission, MICROBIT_INVALID_PARAMETER
+ * if buffer is invalid, or the given bufferLen is <= 0.
*/
int send(uint8_t *buffer, int bufferLen, MicroBitSerialMode mode = MICROBIT_DEFAULT_SERIAL_MODE);
