Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_pkcs11_init.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_pkcs11_init" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_pkcs11_init \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_pkcs11_init(unsigned int " flags ", const char * " configfile ");"
9 .SH ARGUMENTS
10 .IP "unsigned int flags" 12
11 \fBGNUTLS_PKCS11_FLAG_MANUAL\fP or \fBGNUTLS_PKCS11_FLAG_AUTO\fP
12 .IP "const char * configfile" 12
13 either NULL or the location of a configuration file
14 .SH "DESCRIPTION"
15 This function will initialize the PKCS 11 subsystem in gnutls. It will
16 read a configuration file if \fBGNUTLS_PKCS11_FLAG_AUTO\fP is used or allow
17 you to independently load PKCS 11 modules using \fBgnutls_pkcs11_add_provider()\fP
18 if \fBGNUTLS_PKCS11_FLAG_MANUAL\fP is specified.
19
20 Normally you don't need to call this function since it is being called
21 by \fBgnutls_global_init()\fP using the \fBGNUTLS_PKCS11_FLAG_AUTO\fP. If other option
22 is required then it must be called before it.
23 .SH "RETURNS"
24 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
25 negative error value.
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.