diff options
author | Emilia Kasper <emilia@openssl.org> | 2015-09-17 13:55:09 +0200 |
---|---|---|
committer | Emilia Kasper <emilia@openssl.org> | 2015-09-22 20:04:36 +0200 |
commit | 51ff683c12104f667c33f37c1fdb35ab47571ea1 (patch) | |
tree | 4aaaf05ac26da49d484c5f251942f56f3ebeae86 /doc/crypto | |
parent | be250ee2d353a9c8ed858bf8ca274d3107ae2f64 (diff) |
Document BUF_strnlen
Reviewed-by: Matt Caswell <matt@openssl.org>
(cherry picked from commit 21b0fa91186ff1c1c3d956c0593ef4ac02521695)
Diffstat (limited to 'doc/crypto')
-rw-r--r-- | doc/crypto/buffer.pod | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/crypto/buffer.pod b/doc/crypto/buffer.pod index 9d6de53e8e..52c5c841eb 100644 --- a/doc/crypto/buffer.pod +++ b/doc/crypto/buffer.pod @@ -28,6 +28,8 @@ standard C library equivalents size_t BUF_strlcat(char *dst, const char *src, size_t size); + size_t BUF_strnlen(const char *str, size_t maxlen); + =head1 DESCRIPTION The buffer library handles simple character arrays. Buffers are used for @@ -42,11 +44,11 @@ BUF_MEM_grow() changes the size of an already existing buffer to B<len>. Any data already in the buffer is preserved if it increases in size. -BUF_strdup(), BUF_strndup(), BUF_memdup(), BUF_strlcpy() and -BUF_strlcat() are equivalents of the standard C library functions. The -dup() functions use OPENSSL_malloc() underneath and so should be used -in preference to the standard library for memory leak checking or -replacing the malloc() function. +BUF_strdup(), BUF_strndup(), BUF_memdup(), BUF_strlcpy(), +BUF_strlcat() and BUF_strnlen are equivalents of the standard C +library functions. The dup() functions use OPENSSL_malloc() underneath +and so should be used in preference to the standard library for memory +leak checking or replacing the malloc() function. Memory allocated from these functions should be freed up using the OPENSSL_free() function. |