summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_getoperationstate/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rst/legacy/reference/fc_getoperationstate/index.rst')
-rw-r--r--doc/rst/legacy/reference/fc_getoperationstate/index.rst69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/rst/legacy/reference/fc_getoperationstate/index.rst b/doc/rst/legacy/reference/fc_getoperationstate/index.rst
new file mode 100644
index 000000000..aaa679b54
--- /dev/null
+++ b/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:: eval
+
+ 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