Browse Source

Mention negative size returned on string for rtcReceiveMessage()

David Eichmann 3 years ago
parent
commit
4f4e1840da
1 changed files with 1 additions and 1 deletions
  1. 1 1
      DOC.md

+ 1 - 1
DOC.md

@@ -489,7 +489,7 @@ Arguments:
 
 - `id`: the channel identifier
 - `buffer`: a user-supplied buffer where to write the message data
-- `size`: a pointer to a user-supplied int which must be initialized to the size of `buffer`. On success, the function will write the size of the message to it before returning.
+- `size`: a pointer to a user-supplied int which must be initialized to the size of `buffer`. On success, the function will write the size of the message to it before returning (positive size if binary, negative size including terminating 0 if string).
 
 Return value: `RTC_ERR_SUCCESS` or a negative error code (In particular, `RTC_ERR_NOT_AVAIL` is returned when there are no pending messages)