index.rst (1448B)
1 .. _mozilla_projects_nss_reference_fc_generatekey: 2 3 FC_GenerateKey 4 ============== 5 6 `Name <#name>`__ 7 ~~~~~~~~~~~~~~~~ 8 9 .. container:: 10 11 FC_GenerateKey - generate a new key 12 13 `Syntax <#syntax>`__ 14 ~~~~~~~~~~~~~~~~~~~~ 15 16 .. container:: 17 18 .. code:: 19 20 CK_RV FC_GenerateKey( 21 CK_SESSION_HANDLE hSession, 22 CK_MECHANISM_PTR pMechanism, 23 CK_ATTRIBUTE_PTR pTemplate, 24 CK_ULONG ulCount, 25 CK_OBJECT_HANDLE_PTR phKey 26 ); 27 28 `Parameters <#parameters>`__ 29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 30 31 .. container:: 32 33 ``hSession`` 34 [in] session handle. 35 ``pMechanism`` 36 [in] pointer to the mechanism to use. 37 ``pTemplate`` 38 [in] pointer to the template for the new key. 39 ``ulCount`` 40 [in] number of attributes in the template. 41 ``phKey`` 42 [out] pointer to the location to receive the handle of the new key. 43 44 `Description <#description>`__ 45 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 46 47 .. container:: 48 49 ``FC_GenerateKey`` generates a secret key, creating a new key object. The handle of new key is 50 returned. 51 52 A user must log into the token (to assume the NSS User role) before calling ``FC_GenerateKey``. 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 - `NSC_GenerateKey </en-US/NSC_GenerateKey>`__