Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_pkcs11_token_get_url.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_pkcs11_token_get_url" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_pkcs11_token_get_url \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_pkcs11_token_get_url(unsigned int " seq ", gnutls_pkcs11_url_type_t " detailed ", char ** " url ");"
9 .SH ARGUMENTS
10 .IP "unsigned int seq" 12
11 sequence number starting from 0
12 .IP "gnutls_pkcs11_url_type_t detailed" 12
13 non zero if a detailed URL is required
14 .IP "char ** url" 12
15 will contain an allocated url
16 .SH "DESCRIPTION"
17 This function will return the URL for each token available
18 in system. The url has to be released using \fBgnutls_free()\fP
19 .SH "RETURNS"
20 On success, \fBGNUTLS_E_SUCCESS\fP is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP
21 if the sequence number exceeds the available tokens, otherwise a negative error value.
22 .SH "REPORTING BUGS"
23 Report bugs to <bug-gnutls@gnu.org>.
24 GnuTLS home page: http://www.gnu.org/software/gnutls/
25 General help using GNU software: http://www.gnu.org/gethelp/
26 .SH COPYRIGHT
27 Copyright \(co 2008 Free Software Foundation.
28 .br
29 Copying and distribution of this file, with or without modification,
30 are permitted in any medium without royalty provided the copyright
31 notice and this notice are preserved.
32 .SH "SEE ALSO"
33 The full documentation for
34 .B gnutls
35 is maintained as a Texinfo manual.  If the
36 .B info
37 and
38 .B gnutls
39 programs are properly installed at your site, the command
40 .IP
41 .B info gnutls
42 .PP
43 should give you access to the complete manual.