summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_closeallsessions/index.rst
blob: 912f49ec6e11ae6d089019c1270967719af33509 (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
.. _mozilla_projects_nss_reference_fc_closeallsessions:

FC_CloseAllSessions
===================

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

.. container::

   FC_CloseAllSessions - close all sessions between an application and a token.

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

.. container::

   .. code:: eval

      CK_RV FC_CloseAllSessions(
        CK_SLOT_ID slotID
       );

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

.. container::

   ``slotID``
      [in] the ID of the token's slot.

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

.. container::

   ``FC_CloseAllSessions`` closes all sessions between an application and the token in the slot with
   the ID ``slotID``.

   The NSS cryptographic module currently doesn't call the surrender callback function ``Notify``.
   (See PKCS #11 v2.20 section 11.17.1.)

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

.. _return_value:

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

.. container::

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

.. container::

.. _see_also:

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

.. container::

   -  :ref:`mozilla_projects_nss_reference_fc_closesession`,
      `NSC_CloseAllSessions </en-US/NSC_CloseAllSessions>`__