index.rst (1367B)
1 .. _mozilla_projects_nss_reference_fc_getslotlist: 2 3 FC_GetSlotList 4 ============== 5 6 `Name <#name>`__ 7 ~~~~~~~~~~~~~~~~ 8 9 .. container:: 10 11 FC_GetSlotList - Obtain a list of slots in the system. 12 13 `Syntax <#syntax>`__ 14 ~~~~~~~~~~~~~~~~~~~~ 15 16 .. container:: 17 18 .. code:: 19 20 CK_RV FC_GetSlotList( 21 CK_BBOOL tokenPresent, 22 CK_SLOT_ID_PTR pSlotList, 23 CK_ULONG_PTR pulCount 24 ); 25 26 `Parameters <#parameters>`__ 27 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 28 29 .. container:: 30 31 ``tokenPresent`` 32 [in] If true only slots with a token present are included in the list, otherwise all slots are 33 included. 34 ``pSlotList`` 35 [out] Either null or a pointer to an existing array of ``CK_SLOT_ID`` objects. 36 ``pulCount`` 37 [out] Pointer to a ``CK_ULONG`` variable which receives the slot count.; 38 39 `Description <#description>`__ 40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 41 42 .. container:: 43 44 ``FC_GetSlotList`` obtains a list of slots in the system. 45 46 A user may call ``FC_GetSlotList`` without logging into the token (to assume the NSS User role). 47 48 .. _return_value: 49 50 `Return value <#return_value>`__ 51 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 52 53 .. container:: 54 55 ``CKR_OK`` 56 57 `Examples <#examples>`__ 58 ~~~~~~~~~~~~~~~~~~~~~~~~ 59 60 .. container:: 61 62 .. _see_also: 63 64 `See also <#see_also>`__ 65 ~~~~~~~~~~~~~~~~~~~~~~~~ 66 67 .. container:: 68 69 - `NSC_GetSlotList </en-US/NSC_GetSlotList>`__