Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_pkcs12_bag_encrypt.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_pkcs12_bag_encrypt" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_pkcs12_bag_encrypt \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/pkcs12.h>
7 .sp
8 .BI "int gnutls_pkcs12_bag_encrypt(gnutls_pkcs12_bag_t " bag ", const char * " pass ", unsigned int " flags ");"
9 .SH ARGUMENTS
10 .IP "gnutls_pkcs12_bag_t bag" 12
11 The bag
12 .IP "const char * pass" 12
13 The password used for encryption, must be ASCII
14 .IP "unsigned int flags" 12
15 should be one of \fBgnutls_pkcs_encrypt_flags_t\fP elements bitwise or'd
16 .SH "DESCRIPTION"
17 This function will encrypt the given bag.
18 .SH "RETURNS"
19 On success, \fBGNUTLS_E_SUCCESS\fP (zero) is returned,
20 otherwise an error code is returned.
21 .SH "REPORTING BUGS"
22 Report bugs to <bug-gnutls@gnu.org>.
23 GnuTLS home page: http://www.gnu.org/software/gnutls/
24 General help using GNU software: http://www.gnu.org/gethelp/
25 .SH COPYRIGHT
26 Copyright \(co 2008 Free Software Foundation.
27 .br
28 Copying and distribution of this file, with or without modification,
29 are permitted in any medium without royalty provided the copyright
30 notice and this notice are preserved.
31 .SH "SEE ALSO"
32 The full documentation for
33 .B gnutls
34 is maintained as a Texinfo manual.  If the
35 .B info
36 and
37 .B gnutls
38 programs are properly installed at your site, the command
39 .IP
40 .B info gnutls
41 .PP
42 should give you access to the complete manual.