Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_openpgp_keyring_get_crt.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_openpgp_keyring_get_crt" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_openpgp_keyring_get_crt \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/openpgp.h>
7 .sp
8 .BI "int gnutls_openpgp_keyring_get_crt(gnutls_openpgp_keyring_t " ring ", unsigned int " idx ", gnutls_openpgp_crt_t * " cert ");"
9 .SH ARGUMENTS
10 .IP "gnutls_openpgp_keyring_t ring" 12
11 Holds the keyring.
12 .IP "unsigned int idx" 12
13 the index of the certificate to export
14 .IP "gnutls_openpgp_crt_t * cert" 12
15 An uninitialized \fBgnutls_openpgp_crt_t\fP structure
16 .SH "DESCRIPTION"
17 This function will extract an OpenPGP certificate from the given
18 keyring.  If the index given is out of range
19 \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. The
20 returned structure needs to be deinited.
21 .SH "RETURNS"
22 \fBGNUTLS_E_SUCCESS\fP on success, or an error code.
23 .SH "REPORTING BUGS"
24 Report bugs to <bug-gnutls@gnu.org>.
25 GnuTLS home page: http://www.gnu.org/software/gnutls/
26 General help using GNU software: http://www.gnu.org/gethelp/
27 .SH COPYRIGHT
28 Copyright \(co 2008 Free Software Foundation.
29 .br
30 Copying and distribution of this file, with or without modification,
31 are permitted in any medium without royalty provided the copyright
32 notice and this notice are preserved.
33 .SH "SEE ALSO"
34 The full documentation for
35 .B gnutls
36 is maintained as a Texinfo manual.  If the
37 .B info
38 and
39 .B gnutls
40 programs are properly installed at your site, the command
41 .IP
42 .B info gnutls
43 .PP
44 should give you access to the complete manual.