Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_crypto_pk_register2.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_crypto_pk_register2" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_crypto_pk_register2 \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_crypto_pk_register2(int " priority ", int " version ", const gnutls_crypto_pk_st * " s ");"
9 .SH ARGUMENTS
10 .IP "int priority" 12
11 is the priority of the interface
12 .IP "int version" 12
13 should be set to \fBGNUTLS_CRYPTO_API_VERSION\fP
14 .IP "const gnutls_crypto_pk_st * s" 12
15 is a structure holding new interface's data
16 .SH "DESCRIPTION"
17 This function will register an interface for gnutls to operate
18 on public key operations. Any interface registered will override
19 the included interface. The interface with the lowest
20 priority will be used by gnutls.
21
22 Note that the bigint interface must interoperate with the bigint
23 interface. Thus if this interface is updated the
24 \fBgnutls_crypto_bigint_register()\fP should also be used.
25
26 This function should be called before \fBgnutls_global_init()\fP.
27
28 For simplicity you can use the convenience \fBgnutls_crypto_pk_register()\fP
29 macro.
30 .SH "RETURNS"
31 \fBGNUTLS_E_SUCCESS\fP on success, otherwise an error.
32 .SH "SINCE"
33 2.6.0
34 .SH "REPORTING BUGS"
35 Report bugs to <bug-gnutls@gnu.org>.
36 GnuTLS home page: http://www.gnu.org/software/gnutls/
37 General help using GNU software: http://www.gnu.org/gethelp/
38 .SH COPYRIGHT
39 Copyright \(co 2008 Free Software Foundation.
40 .br
41 Copying and distribution of this file, with or without modification,
42 are permitted in any medium without royalty provided the copyright
43 notice and this notice are preserved.
44 .SH "SEE ALSO"
45 The full documentation for
46 .B gnutls
47 is maintained as a Texinfo manual.  If the
48 .B info
49 and
50 .B gnutls
51 programs are properly installed at your site, the command
52 .IP
53 .B info gnutls
54 .PP
55 should give you access to the complete manual.