Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_pkcs11_obj_get_info.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_pkcs11_obj_get_info" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_pkcs11_obj_get_info \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_pkcs11_obj_get_info(gnutls_pkcs11_obj_t " crt ", gnutls_pkcs11_obj_info_t " itype ", void * " output ", size_t * " output_size ");"
9 .SH ARGUMENTS
10 .IP "gnutls_pkcs11_obj_t crt" 12
11 should contain a \fBgnutls_pkcs11_obj_t\fP structure
12 .IP "gnutls_pkcs11_obj_info_t itype" 12
13 Denotes the type of information requested
14 .IP "void * output" 12
15 where output will be stored
16 .IP "size_t * output_size" 12
17 contains the maximum size of the output and will be overwritten with actual
18 .SH "DESCRIPTION"
19 This function will return information about the PKCS 11 certificatesuch
20 as the label, id as well as token information where the key is stored. When
21 output is text it returns null terminated string although \fBoutput_size\fP contains
22 the size of the actual data only.
23 .SH "RETURNS"
24 zero on success or a negative value on error.
25 .SH "REPORTING BUGS"
26 Report bugs to <bug-gnutls@gnu.org>.
27 GnuTLS home page: http://www.gnu.org/software/gnutls/
28 General help using GNU software: http://www.gnu.org/gethelp/
29 .SH COPYRIGHT
30 Copyright \(co 2008 Free Software Foundation.
31 .br
32 Copying and distribution of this file, with or without modification,
33 are permitted in any medium without royalty provided the copyright
34 notice and this notice are preserved.
35 .SH "SEE ALSO"
36 The full documentation for
37 .B gnutls
38 is maintained as a Texinfo manual.  If the
39 .B info
40 and
41 .B gnutls
42 programs are properly installed at your site, the command
43 .IP
44 .B info gnutls
45 .PP
46 should give you access to the complete manual.