mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-26 16:48:48 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
29 lines
965 B
Groff
29 lines
965 B
Groff
.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
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest,
|
|
unsigned int *dest_len, const char *src,
|
|
unsigned int src_len);
|
|
.fi
|
|
.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.
|