summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_digestfinal/index.rst
blob: 6c230dbd92fff96e06ee03c6610788f022788a35 (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
.. _mozilla_projects_nss_reference_fc_digestfinal:

FC_DigestFinal
==============

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

.. container::

   FC_DigestFinal - finish a multi-part digest operation.

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

.. container::

   .. code:: eval

      CK_RV FC_DigestFinal(
        CK_SESSION_HANDLE hSession,
        CK_BYTE_PTR pDigest,
        CK_ULONG_PTR pulDigestLen
      );

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

.. container::

   ``hSession``
      [in] session handle.
   ``pDigest``
      [out] pointer to the buffer which will receive the digest or NULL.
   ``pulDigestLen``
      [in, out] pointer to location containing the maximum buffer size.

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

.. container::

   ``FC_DigestFinal`` finishes a multi-part digest operation by returning the complete digest and
   clearing the operation context. If ``pDigest`` is NULL the length of the digest is returned and
   ``FC_DigestFinal`` may be called again with ``pDigest`` set to retrieve the digest.

   A user may call ``FC_DigestFinal`` 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_digestinit`,
      `NSC_DigestFinal </en-US/NSC_DigestFinal>`__