Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_pkcs12_bag_set_friendly_name.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_pkcs12_bag_set_friendly_name" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_pkcs12_bag_set_friendly_name \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/pkcs12.h>
7 .sp
8 .BI "int gnutls_pkcs12_bag_set_friendly_name(gnutls_pkcs12_bag_t " bag ", int " indx ", const char * " name ");"
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 "const char * name" 12
15 the name
16 .SH "DESCRIPTION"
17 This function will add the given key friendly name, to the
18 specified, by the index, bag element. The name will be encoded as
19 a 'Friendly name' bag attribute, which is usually used to set a
20 user name to the local private key and the certificate pair.
21 .SH "RETURNS"
22 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
23 negative error value. or a negative value on error.
24 .SH "REPORTING BUGS"
25 Report bugs to <bug-gnutls@gnu.org>.
26 GnuTLS home page: http://www.gnu.org/software/gnutls/
27 General help using GNU software: http://www.gnu.org/gethelp/
28 .SH COPYRIGHT
29 Copyright \(co 2008 Free Software Foundation.
30 .br
31 Copying and distribution of this file, with or without modification,
32 are permitted in any medium without royalty provided the copyright
33 notice and this notice are preserved.
34 .SH "SEE ALSO"
35 The full documentation for
36 .B gnutls
37 is maintained as a Texinfo manual.  If the
38 .B info
39 and
40 .B gnutls
41 programs are properly installed at your site, the command
42 .IP
43 .B info gnutls
44 .PP
45 should give you access to the complete manual.