Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_privkey_decrypt_data.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_privkey_decrypt_data" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_privkey_decrypt_data \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_privkey_decrypt_data(gnutls_privkey_t " key ", unsigned int " flags ", const gnutls_datum_t * " ciphertext ", gnutls_datum_t * " plaintext ");"
9 .SH ARGUMENTS
10 .IP "gnutls_privkey_t key" 12
11 Holds the key
12 .IP "unsigned int flags" 12
13 zero for now
14 .IP "const gnutls_datum_t * ciphertext" 12
15 holds the data to be decrypted
16 .IP "gnutls_datum_t * plaintext" 12
17 will contain the decrypted data, allocated with \fBgnutls_malloc()\fP
18 .SH "DESCRIPTION"
19 This function will decrypt the given data using the algorithm
20 supported by the private key.
21 .SH "RETURNS"
22 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
23 negative error value.
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.