index.rst (1465B)
1 .. _mozilla_projects_nss_reference_fc_encrypt: 2 3 FC_Encrypt 4 ========== 5 6 `Name <#name>`__ 7 ~~~~~~~~~~~~~~~~ 8 9 .. container:: 10 11 FC_Encrypt - Encrypt a block of data. 12 13 `Syntax <#syntax>`__ 14 ~~~~~~~~~~~~~~~~~~~~ 15 16 .. container:: 17 18 .. code:: 19 20 CK_RV FC_Encrypt( 21 CK_SESSION_HANDLE hSession, 22 CK_BYTE_PTR pData, 23 CK_ULONG usDataLen, 24 CK_BYTE_PTR pEncryptedData, 25 CK_ULONG_PTR pusEncryptedDataLen 26 ); 27 28 `Parameters <#parameters>`__ 29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 30 31 .. container:: 32 33 ``hSession`` 34 [in] session handle. 35 ``pData`` 36 [in] pointer to the data buffer 37 ``usDataLen`` 38 [in] length of the data buffer in bytes. 39 ``pEncryptedData`` 40 [out] pointer to location where encrypted data is to be stored. 41 ``pusEncryptedDataLen`` 42 [in/out] number of bytes. 43 44 `Description <#description>`__ 45 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 46 47 .. container:: 48 49 ``FC_Encrypt`` encrypts a block of data according to the attributes of the previous call to 50 ``FC_EncryptInit``. 51 52 A user must log into the token (to assume the NSS User role) before calling ``FC_Encrypt``. 53 54 .. _return_value: 55 56 `Return value <#return_value>`__ 57 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 58 59 .. container:: 60 61 `Examples <#examples>`__ 62 ~~~~~~~~~~~~~~~~~~~~~~~~ 63 64 .. container:: 65 66 .. _see_also: 67 68 `See also <#see_also>`__ 69 ~~~~~~~~~~~~~~~~~~~~~~~~ 70 71 .. container:: 72 73 - :ref:`mozilla_projects_nss_reference_fc_encryptinit`, `NSC_Encrypt </en-US/NSC_Encrypt>`__