aboutsummaryrefslogtreecommitdiffhomepage
path: root/include
diff options
context:
space:
mode:
authorLee Salzman <[email protected]>2014-02-20 19:55:51 +0200
committerLee Salzman <[email protected]>2014-02-20 19:55:51 +0200
commitc58ec4cc448ccdc933d53241ce14a61a020140c7 (patch)
tree3ae97714a503d4e1feadf55f14744312d6157232 /include
parentb3de8a29c4fc4de3919b13475599660e2e157f5b (diff)
downloadenet-c58ec4cc448ccdc933d53241ce14a61a020140c7.tar.gz
enet-c58ec4cc448ccdc933d53241ce14a61a020140c7.zip
note about null-termination in enet_address_get_host
Diffstat (limited to 'include')
-rw-r--r--include/enet/enet.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/include/enet/enet.h b/include/enet/enet.h
index 948f44e..dd51e95 100644
--- a/include/enet/enet.h
+++ b/include/enet/enet.h
@@ -517,6 +517,7 @@ ENET_API int enet_address_set_host (ENetAddress * address, const char * hostName
@returns the null-terminated name of the host in hostName on success
@retval 0 on success
@retval < 0 on failure
+ @remarks if the name's length matches or exceeds nameLength, the result may not be null-terminated
*/
ENET_API int enet_address_get_host_ip (const ENetAddress * address, char * hostName, size_t nameLength);
@@ -527,6 +528,7 @@ ENET_API int enet_address_get_host_ip (const ENetAddress * address, char * hostN
@returns the null-terminated name of the host in hostName on success
@retval 0 on success
@retval < 0 on failure
+ @remarks if the name's length matches or exceeds nameLength, the result may not be null-terminated
*/
ENET_API int enet_address_get_host (const ENetAddress * address, char * hostName, size_t nameLength);