From 26a029d407be480d791972afb5975cf62c9360a6 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Fri, 19 Apr 2024 02:47:55 +0200
Subject: Adding upstream version 124.0.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 .../reference/fc_getoperationstate/index.rst       | 69 ++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 security/nss/doc/rst/legacy/reference/fc_getoperationstate/index.rst

(limited to 'security/nss/doc/rst/legacy/reference/fc_getoperationstate/index.rst')

diff --git a/security/nss/doc/rst/legacy/reference/fc_getoperationstate/index.rst b/security/nss/doc/rst/legacy/reference/fc_getoperationstate/index.rst
new file mode 100644
index 0000000000..1ec38bd7de
--- /dev/null
+++ b/security/nss/doc/rst/legacy/reference/fc_getoperationstate/index.rst
@@ -0,0 +1,69 @@
+.. _mozilla_projects_nss_reference_fc_getoperationstate:
+
+FC_GetOperationState
+====================
+
+`Name <#name>`__
+~~~~~~~~~~~~~~~~
+
+.. container::
+
+   FC_GetOperationState - get the cryptographic operation state of a session.
+
+`Syntax <#syntax>`__
+~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+   .. code::
+
+      CK_RV FC_GetOperationState(
+        CK_SESSION_HANDLE hSession,
+        CK_BYTE_PTR  pOperationState,
+        CK_ULONG_PTR pulOperationStateLen
+      );
+
+`Parameters <#parameters>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+   ``hSession``
+      [in] handle of the open session.
+   ``pOperationState``
+      [out] pointer to a byte array of a length sufficient for containing the operation state or
+      NULL.
+   ``pulOperationStateLen``
+      [out] pointer to `CK_ULONG </en-US/CK_ULONG>`__ which receives the total length (in bytes) of
+      the operation state.
+
+`Description <#description>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+   ``FC_GetOperationState`` saves the state of the cryptographic operation in a session. This
+   function only works for digest operations for now. Therefore, a user may call
+   ``FC_GetOperationState`` 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_setoperationstate`,
+      `NSC_GetOperationState </en-US/NSC_GetOperationState>`__
\ No newline at end of file
-- 
cgit v1.2.3