summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_encryptfinal/index.rst
blob: 2cbf55c9fb59980d6c71ebd4fe89a5263df975de (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
.. _mozilla_projects_nss_reference_fc_encryptfinal:

FC_EncryptFinal
===============

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

.. container::

   FC_EncryptFinal - finish a multi-part encryption operation.

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

.. container::

   .. code:: eval

      CK_RV FC_EncryptFinal(
        CK_SESSION_HANDLE hSession,
        CK_BYTE_PTR pLastEncryptedPart,
        CK_ULONG_PTR pusLastEncryptedPartLen
      );

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

.. container::

   ``hSession``
      [in] session handle.
   ``pLastEncryptedPart``
      [out] pointer to the location that receives the last encrypted data part, if any
   ``pusLastEncryptedPartLen``
      [in,out] pointer to location where the number of bytes of the last encrypted data part is to
      be stored.

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

.. container::

   ``FC_EncryptFinal`` returns the last block of data of a multi-part encryption operation.

   A user must log into the token (to assume the NSS User role) before calling ``FC_EncryptFinal``.

.. _return_value:

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

.. container::

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

.. container::

.. _see_also:

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

.. container::

   -  :ref:`mozilla_projects_nss_reference_fc_encryptinit`,
      `NSC_EncryptFinal </en-US/NSC_EncryptFinal>`__