Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_srp_base64_decode_alloc.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_srp_base64_decode_alloc" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_srp_base64_decode_alloc \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_srp_base64_decode_alloc(const gnutls_datum_t * " b64_data ", gnutls_datum_t * " result ");"
9 .SH ARGUMENTS
10 .IP "const gnutls_datum_t * b64_data" 12
11 contains the encoded data
12 .IP "gnutls_datum_t * result" 12
13 the place where decoded data lie
14 .SH "DESCRIPTION"
15 This function will decode the given encoded data. The decoded data
16 will be allocated, and stored into result.  It will decode using
17 the base64 algorithm as used in libsrp.
18
19 You should use \fBgnutls_free()\fP to free the returned data.
20
21 Warning!  This base64 encoding is not the "standard" encoding, so
22 do not use it for non\-SRP purposes.
23 .SH "RETURNS"
24 0 on success, or an error code.
25 .SH "REPORTING BUGS"
26 Report bugs to <bug-gnutls@gnu.org>.
27 GnuTLS home page: http://www.gnu.org/software/gnutls/
28 General help using GNU software: http://www.gnu.org/gethelp/
29 .SH COPYRIGHT
30 Copyright \(co 2008 Free Software Foundation.
31 .br
32 Copying and distribution of this file, with or without modification,
33 are permitted in any medium without royalty provided the copyright
34 notice and this notice are preserved.
35 .SH "SEE ALSO"
36 The full documentation for
37 .B gnutls
38 is maintained as a Texinfo manual.  If the
39 .B info
40 and
41 .B gnutls
42 programs are properly installed at your site, the command
43 .IP
44 .B info gnutls
45 .PP
46 should give you access to the complete manual.