summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_cancelfunction/index.rst
blob: a386c2f760e60343629a85103e98551ef7f83995 (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
.. _mozilla_projects_nss_reference_fc_cancelfunction:

FC_CancelFunction
=================

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

.. container::

   FC_CancelFunction - cancel a function running in parallel

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

.. container::

   .. code:: eval

      CK_RV FC_CancelFunction(
        CK_SESSION_HANDLE hSession
      );

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

.. container::

   ``hSession``
      [in] session handle.

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

.. container::

   Parallel functions are not implemented. ``FC_CancelFunction`` is a legacy function that simply
   returns ``CKR_FUNCTION_NOT_PARALLEL``.

.. _return_value:

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

.. container::

   ``FC_CancelFunction`` always returns ``CKR_FUNCTION_NOT_PARALLEL``.

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

.. container::

.. _see_also:

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

.. container::

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