Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_openpgp_privkey_import.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_openpgp_privkey_import" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_openpgp_privkey_import \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/openpgp.h>
7 .sp
8 .BI "int gnutls_openpgp_privkey_import(gnutls_openpgp_privkey_t " key ", const gnutls_datum_t * " data ", gnutls_openpgp_crt_fmt_t " format ", const char * " password ", unsigned int " flags ");"
9 .SH ARGUMENTS
10 .IP "gnutls_openpgp_privkey_t key" 12
11 The structure to store the parsed key.
12 .IP "const gnutls_datum_t * data" 12
13 The RAW or BASE64 encoded key.
14 .IP "gnutls_openpgp_crt_fmt_t format" 12
15 One of \fBgnutls_openpgp_crt_fmt_t\fP elements.
16 .IP "const char * password" 12
17 not used for now
18 .IP "unsigned int flags" 12
19 should be zero
20 .SH "DESCRIPTION"
21 This function will convert the given RAW or Base64 encoded key to
22 the native gnutls_openpgp_privkey_t format.  The output will be
23 stored in 'key'.
24 .SH "RETURNS"
25 \fBGNUTLS_E_SUCCESS\fP on success, or an error code.
26 .SH "REPORTING BUGS"
27 Report bugs to <bug-gnutls@gnu.org>.
28 GnuTLS home page: http://www.gnu.org/software/gnutls/
29 General help using GNU software: http://www.gnu.org/gethelp/
30 .SH COPYRIGHT
31 Copyright \(co 2008 Free Software Foundation.
32 .br
33 Copying and distribution of this file, with or without modification,
34 are permitted in any medium without royalty provided the copyright
35 notice and this notice are preserved.
36 .SH "SEE ALSO"
37 The full documentation for
38 .B gnutls
39 is maintained as a Texinfo manual.  If the
40 .B info
41 and
42 .B gnutls
43 programs are properly installed at your site, the command
44 .IP
45 .B info gnutls
46 .PP
47 should give you access to the complete manual.