summaryrefslogtreecommitdiffstats
path: root/security/nss/doc/rst/legacy/reference/fc_getmechanismlist/index.rst
blob: 11003f9831b5ed31b50c2892d4206efcfba250c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.. _mozilla_projects_nss_reference_fc_getmechanismlist:

FC_GetMechanismList
===================

`Name <#name>`__
~~~~~~~~~~~~~~~~

.. container::

   FC_GetMechanismList - get a list of mechanism types supported by a token.

`Syntax <#syntax>`__
~~~~~~~~~~~~~~~~~~~~

.. container::

   .. code::

      CK_RV FC_GetMechanismList(
        CK_SLOT_ID slotID,
        CK_MECHANISM_TYPE_PTR pMechanismList,
        CK_ULONG_PTR pusCount
      );

`Parameters <#parameters>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   ``FC_GetMechanismList`` takes three parameters:

   ``slotID``
      [Input]
   ``pInfo``
      [Output] The address of a variable that will receive a pointer to the list of function
      pointers.

`Description <#description>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   ``FC_GetMechanismList`` obtains a list of mechanism types supported by a token.

   A user may call ``FC_GetMechanismList`` without logging into the token (to assume the NSS User
   role).

.. _return_value:

`Return value <#return_value>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   ``CKR_OK``

`Examples <#examples>`__
~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

.. _see_also:

`See also <#see_also>`__
~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   -  `NSC_GetMechanismList </en-US/NSC_GetMechanismList>`__