Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_pkcs12_bag_get_key_id.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_pkcs12_bag_get_key_id" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_pkcs12_bag_get_key_id \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/pkcs12.h>
7 .sp
8 .BI "int gnutls_pkcs12_bag_get_key_id(gnutls_pkcs12_bag_t " bag ", int " indx ", gnutls_datum_t * " id ");"
9 .SH ARGUMENTS
10 .IP "gnutls_pkcs12_bag_t bag" 12
11 The bag
12 .IP "int indx" 12
13 The bag's element to add the id
14 .IP "gnutls_datum_t * id" 12
15 where the ID will be copied (to be treated as const)
16 .SH "DESCRIPTION"
17 This function will return the key ID, of the specified bag element.
18 The key ID is usually used to distinguish the local private key and
19 the certificate pair.
20 .SH "RETURNS"
21 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
22 negative error value. or a negative value on error.
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.