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