index.rst (1415B)
1 .. _mozilla_projects_nss_reference_fc_encryptinit: 2 3 FC_EncryptInit 4 ============== 5 6 `Name <#name>`__ 7 ~~~~~~~~~~~~~~~~ 8 9 .. container:: 10 11 FC_EncryptInit - initialize an encryption operation. 12 13 `Syntax <#syntax>`__ 14 ~~~~~~~~~~~~~~~~~~~~ 15 16 .. container:: 17 18 .. code:: 19 20 CK_RV FC_EncryptInit( 21 CK_SESSION_HANDLE hSession, 22 CK_MECHANISM_PTR pMechanism, 23 CK_OBJECT_HANDLE hKey 24 ); 25 26 `Parameters <#parameters>`__ 27 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 28 29 .. container:: 30 31 ``hSession`` 32 [in] handle to the session. 33 ``pMechanism`` 34 [in] pointer to the mechanism to be used for subsequent encryption. 35 ``hKey`` 36 [in] handle of the encryption key. 37 38 `Description <#description>`__ 39 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 40 41 .. container:: 42 43 ``FC_EncryptInit`` initializes an encryption operation with the mechanism and key to be used. 44 45 A user must log into the token (to assume the NSS User role) before calling ``FC_EncryptInit``. 46 47 .. _return_value: 48 49 `Return value <#return_value>`__ 50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 51 52 .. container:: 53 54 ``CKR_OK`` 55 Slot information was successfully copied. 56 ``CKR_SLOT_ID_INVALID`` 57 The specified slot number is out of the defined range of values. 58 59 `Examples <#examples>`__ 60 ~~~~~~~~~~~~~~~~~~~~~~~~ 61 62 .. container:: 63 64 .. _see_also: 65 66 `See also <#see_also>`__ 67 ~~~~~~~~~~~~~~~~~~~~~~~~ 68 69 .. container:: 70 71 - `NSC_EncryptInit </en-US/NSC_EncryptInit>`__