Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_hex_decode.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_hex_decode" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_hex_decode \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_hex_decode(const gnutls_datum_t * " hex_data ", char * " result ", size_t * " result_size ");"
9 .SH ARGUMENTS
10 .IP "const gnutls_datum_t * hex_data" 12
11 contain the encoded data
12 .IP "char * result" 12
13 the place where decoded data will be copied
14 .IP "size_t * result_size" 12
15 holds the size of the result
16 .SH "DESCRIPTION"
17 This function will decode the given encoded data, using the hex
18 encoding used by PSK password files.
19
20 Note that hex_data should be null terminated.
21 .SH "RETURNS"
22 \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not
23 long enough, or 0 on success.
24 .SH "REPORTING BUGS"
25 Report bugs to <bug-gnutls@gnu.org>.
26 GnuTLS home page: http://www.gnu.org/software/gnutls/
27 General help using GNU software: http://www.gnu.org/gethelp/
28 .SH COPYRIGHT
29 Copyright \(co 2008 Free Software Foundation.
30 .br
31 Copying and distribution of this file, with or without modification,
32 are permitted in any medium without royalty provided the copyright
33 notice and this notice are preserved.
34 .SH "SEE ALSO"
35 The full documentation for
36 .B gnutls
37 is maintained as a Texinfo manual.  If the
38 .B info
39 and
40 .B gnutls
41 programs are properly installed at your site, the command
42 .IP
43 .B info gnutls
44 .PP
45 should give you access to the complete manual.