summaryrefslogtreecommitdiff
path: root/toxcore/tox.api.h
diff options
context:
space:
mode:
authorzugz (tox) <mbays+tox@sdf.org>2019-01-21 19:42:10 +0100
committerzugz (tox) <mbays+tox@sdf.org>2019-01-21 22:17:49 +0100
commit0aad180d1e1d7dae7cbf2868e139af0a4dc34fe7 (patch)
tree4d991872ecc074b42e87040ef6330ef9e4ea1e38 /toxcore/tox.api.h
parent98b754e1f22220f10196760389371dba6d139c6f (diff)
Specify that buffer size for tox_conference_peer_get_name is given by $size
Diffstat (limited to 'toxcore/tox.api.h')
-rw-r--r--toxcore/tox.api.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/toxcore/tox.api.h b/toxcore/tox.api.h
index 237254de..2e5c7841 100644
--- a/toxcore/tox.api.h
+++ b/toxcore/tox.api.h
@@ -1377,7 +1377,7 @@ namespace friend {
1377 * Write the status message of the friend designated by the given friend number to a byte 1377 * Write the status message of the friend designated by the given friend number to a byte
1378 * array. 1378 * array.
1379 * 1379 *
1380 * Call $size to determine the allocation size for the `status_name` 1380 * Call $size to determine the allocation size for the `status_message`
1381 * parameter. 1381 * parameter.
1382 * 1382 *
1383 * The data written to `status_message` is equal to the data received by the last 1383 * The data written to `status_message` is equal to the data received by the last
@@ -2294,7 +2294,10 @@ namespace conference {
2294 2294
2295 /** 2295 /**
2296 * Copy the name of peer_number who is in conference_number to name. 2296 * Copy the name of peer_number who is in conference_number to name.
2297 * name must be at least $MAX_NAME_LENGTH long. 2297 *
2298 * Call $size to determine the allocation size for the `name` parameter.
2299 *
2300 * @param name A valid memory region large enough to store the peer's name.
2298 * 2301 *
2299 * @return true on success. 2302 * @return true on success.
2300 */ 2303 */
@@ -2339,7 +2342,10 @@ namespace conference {
2339 2342
2340 /** 2343 /**
2341 * Copy the name of offline_peer_number who is in conference_number to name. 2344 * Copy the name of offline_peer_number who is in conference_number to name.
2342 * name must be at least $MAX_NAME_LENGTH long. 2345 *
2346 * Call $size to determine the allocation size for the `name` parameter.
2347 *
2348 * @param name A valid memory region large enough to store the peer's name.
2343 * 2349 *
2344 * @return true on success. 2350 * @return true on success.
2345 */ 2351 */