summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_pkcs11_token_get_mechanism
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/gnutls_pkcs11_token_get_mechanism')
-rw-r--r--doc/functions/gnutls_pkcs11_token_get_mechanism19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/functions/gnutls_pkcs11_token_get_mechanism b/doc/functions/gnutls_pkcs11_token_get_mechanism
new file mode 100644
index 0000000..4bb570a
--- /dev/null
+++ b/doc/functions/gnutls_pkcs11_token_get_mechanism
@@ -0,0 +1,19 @@
+
+
+
+
+@deftypefun {int} {gnutls_pkcs11_token_get_mechanism} (const char * @var{url}, unsigned int @var{idx}, unsigned long * @var{mechanism})
+@var{url}: should contain a PKCS 11 URL
+
+@var{idx}: The index of the mechanism
+
+@var{mechanism}: The PKCS @code{11} mechanism ID
+
+This function will return the names of the supported mechanisms
+by the token. It should be called with an increasing index until
+it return GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE.
+
+@strong{Returns:} @code{GNUTLS_E_SUCCESS} (0) on success or a negative error code on error.
+
+@strong{Since:} 2.12.0
+@end deftypefun