index.rst (1606B)
1 .. _mozilla_projects_nss_reference_fc_getoperationstate: 2 3 FC_GetOperationState 4 ==================== 5 6 `Name <#name>`__ 7 ~~~~~~~~~~~~~~~~ 8 9 .. container:: 10 11 FC_GetOperationState - get the cryptographic operation state of a session. 12 13 `Syntax <#syntax>`__ 14 ~~~~~~~~~~~~~~~~~~~~ 15 16 .. container:: 17 18 .. code:: 19 20 CK_RV FC_GetOperationState( 21 CK_SESSION_HANDLE hSession, 22 CK_BYTE_PTR pOperationState, 23 CK_ULONG_PTR pulOperationStateLen 24 ); 25 26 `Parameters <#parameters>`__ 27 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 28 29 .. container:: 30 31 ``hSession`` 32 [in] handle of the open session. 33 ``pOperationState`` 34 [out] pointer to a byte array of a length sufficient for containing the operation state or 35 NULL. 36 ``pulOperationStateLen`` 37 [out] pointer to `CK_ULONG </en-US/CK_ULONG>`__ which receives the total length (in bytes) of 38 the operation state. 39 40 `Description <#description>`__ 41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 42 43 .. container:: 44 45 ``FC_GetOperationState`` saves the state of the cryptographic operation in a session. This 46 function only works for digest operations for now. Therefore, a user may call 47 ``FC_GetOperationState`` without logging into the token (to assume the NSS User role). 48 49 .. _return_value: 50 51 `Return value <#return_value>`__ 52 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 53 54 .. container:: 55 56 `Examples <#examples>`__ 57 ~~~~~~~~~~~~~~~~~~~~~~~~ 58 59 .. container:: 60 61 .. _see_also: 62 63 `See also <#see_also>`__ 64 ~~~~~~~~~~~~~~~~~~~~~~~~ 65 66 .. container:: 67 68 - :ref:`mozilla_projects_nss_reference_fc_setoperationstate`, 69 `NSC_GetOperationState </en-US/NSC_GetOperationState>`__