index.rst (1361B)
1 .. _mozilla_projects_nss_reference_fc_getslotinfo: 2 3 FC_GetSlotInfo 4 ============== 5 6 `Name <#name>`__ 7 ~~~~~~~~~~~~~~~~ 8 9 .. container:: 10 11 FC_GetSlotInfo - get information about a particular slot in the system. 12 13 `Syntax <#syntax>`__ 14 ~~~~~~~~~~~~~~~~~~~~ 15 16 .. container:: 17 18 .. code:: 19 20 CK_RV FC_GetSlotInfo( 21 CK_SLOT_ID slotID, 22 CK_SLOT_INFO_PTR pInfo 23 ); 24 25 `Parameters <#parameters>`__ 26 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 27 28 .. container:: 29 30 ``FC_GetSlotInfo`` takes two parameters: 31 32 ``slotID`` 33 [in] 34 ``pInfo`` 35 [out] The address of a ``CK_SLOT_INFO`` structure. 36 37 `Description <#description>`__ 38 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 39 40 .. container:: 41 42 ``FC_GetSlotInfo`` stores the information about the slot in the ``CK_SLOT_INFO`` structure that 43 ``pInfo`` points to. 44 45 A user may call ``FC_GetSlotInfo`` without logging into the token (to assume the NSS User role). 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_GetSlotInfo </en-US/NSC_GetSlotInfo>`__