index.rst (1645B)
1 .. _mozilla_projects_nss_reference_fc_opensession: 2 3 FC_OpenSession 4 ============== 5 6 `Name <#name>`__ 7 ~~~~~~~~~~~~~~~~ 8 9 .. container:: 10 11 FC_OpenSession - open a session between an application and a token. 12 13 `Syntax <#syntax>`__ 14 ~~~~~~~~~~~~~~~~~~~~ 15 16 .. container:: 17 18 .. code:: 19 20 CK_RV FC_OpenSession( 21 CK_SLOT_ID slotID, 22 CK_FLAGS flags, 23 CK_VOID_PTR pApplication, 24 CK_NOTIFY Notify, 25 CK_SESSION_HANDLE_PTR phSession 26 ); 27 28 `Parameters <#parameters>`__ 29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 30 31 .. container:: 32 33 ``FC_OpenSession`` has the following parameters: 34 35 ``slotID`` 36 [in] the ID of the token's slot. 37 ``flags`` 38 [in] 39 ``pApplication`` 40 ``Notify`` 41 [in] pointer to a notification callback function. Not currently supported. 42 ``phSession`` 43 [out] pointer to a session handle. 44 45 `Description <#description>`__ 46 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 47 48 .. container:: 49 50 ``FC_OpenSession`` opens a session between an application and the token in the slot with the ID 51 ``slotID``. 52 53 The NSS cryptographic module currently doesn't call the surrender callback function ``Notify``. 54 (See PKCS #11 v2.20 section 11.17.1.) 55 56 A user may call ``FC_OpenSession`` without logging into the token (to assume the NSS User role). 57 58 .. _return_value: 59 60 `Return value <#return_value>`__ 61 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 62 63 .. container:: 64 65 `Examples <#examples>`__ 66 ~~~~~~~~~~~~~~~~~~~~~~~~ 67 68 .. container:: 69 70 .. _see_also: 71 72 `See also <#see_also>`__ 73 ~~~~~~~~~~~~~~~~~~~~~~~~ 74 75 .. container:: 76 77 - :ref:`mozilla_projects_nss_reference_fc_closesession`, 78 `NSC_OpenSession </en-US/NSC_OpenSession>`__