summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_digestfinal/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rst/legacy/reference/fc_digestfinal/index.rst')
-rw-r--r--doc/rst/legacy/reference/fc_digestfinal/index.rst69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/rst/legacy/reference/fc_digestfinal/index.rst b/doc/rst/legacy/reference/fc_digestfinal/index.rst
new file mode 100644
index 000000000..6c230dbd9
--- /dev/null
+++ b/doc/rst/legacy/reference/fc_digestfinal/index.rst
@@ -0,0 +1,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>`__ \ No newline at end of file