diff options
Diffstat (limited to 'libssh2-sys/libssh2-1.5.0/docs/libssh2_base64_decode.3')
| -rw-r--r-- | libssh2-sys/libssh2-1.5.0/docs/libssh2_base64_decode.3 | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_base64_decode.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_base64_decode.3 new file mode 100644 index 0000000..932f03a --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_base64_decode.3 @@ -0,0 +1,25 @@ +.TH libssh2_base64_decode 3 "23 Dec 2008" "libssh2 1.0" "libssh2 manual" +.SH NAME +libssh2_base64_decode - decode a base64 encoded string +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest, + unsigned int *dest_len, const char *src, + unsigned int src_len); +.SH DESCRIPTION +This function is deemed DEPRECATED and will be removed from libssh2 in a +future version. Don't use it! + +Decode a base64 chunk and store it into a newly allocated buffer. 'dest_len' +will be set to hold the length of the returned buffer that '*dest' will point +to. + +The returned buffer is allocated by this function, but it is not clear how to +free that memory! +.SH BUGS +The memory that *dest points to is allocated by the malloc function libssh2 +uses, but there's no way for an application to free this data in a safe and +reliable way! +.SH RETURN VALUE +0 if successful, \-1 if any error occurred. |