summaryrefslogtreecommitdiff
path: root/toxcore/tox.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.h
parent98b754e1f22220f10196760389371dba6d139c6f (diff)
Specify that buffer size for tox_conference_peer_get_name is given by $size
Diffstat (limited to 'toxcore/tox.h')
-rw-r--r--toxcore/tox.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/toxcore/tox.h b/toxcore/tox.h
index ba67d5ad..30ae7187 100644
--- a/toxcore/tox.h
+++ b/toxcore/tox.h
@@ -1556,7 +1556,7 @@ size_t tox_friend_get_status_message_size(const Tox *tox, uint32_t friend_number
1556 * Write the status message of the friend designated by the given friend number to a byte 1556 * Write the status message of the friend designated by the given friend number to a byte
1557 * array. 1557 * array.
1558 * 1558 *
1559 * Call tox_friend_get_status_message_size to determine the allocation size for the `status_name` 1559 * Call tox_friend_get_status_message_size to determine the allocation size for the `status_message`
1560 * parameter. 1560 * parameter.
1561 * 1561 *
1562 * The data written to `status_message` is equal to the data received by the last 1562 * The data written to `status_message` is equal to the data received by the last
@@ -2609,7 +2609,10 @@ size_t tox_conference_peer_get_name_size(const Tox *tox, uint32_t conference_num
2609 2609
2610/** 2610/**
2611 * Copy the name of peer_number who is in conference_number to name. 2611 * Copy the name of peer_number who is in conference_number to name.
2612 * name must be at least TOX_MAX_NAME_LENGTH long. 2612 *
2613 * Call tox_conference_peer_get_name_size to determine the allocation size for the `name` parameter.
2614 *
2615 * @param name A valid memory region large enough to store the peer's name.
2613 * 2616 *
2614 * @return true on success. 2617 * @return true on success.
2615 */ 2618 */
@@ -2645,7 +2648,10 @@ size_t tox_conference_offline_peer_get_name_size(const Tox *tox, uint32_t confer
2645 2648
2646/** 2649/**
2647 * Copy the name of offline_peer_number who is in conference_number to name. 2650 * Copy the name of offline_peer_number who is in conference_number to name.
2648 * name must be at least TOX_MAX_NAME_LENGTH long. 2651 *
2652 * Call tox_conference_offline_peer_get_name_size to determine the allocation size for the `name` parameter.
2653 *
2654 * @param name A valid memory region large enough to store the peer's name.
2649 * 2655 *
2650 * @return true on success. 2656 * @return true on success.
2651 */ 2657 */