summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_getslotlist/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rst/legacy/reference/fc_getslotlist/index.rst')
-rw-r--r--doc/rst/legacy/reference/fc_getslotlist/index.rst69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/rst/legacy/reference/fc_getslotlist/index.rst b/doc/rst/legacy/reference/fc_getslotlist/index.rst
new file mode 100644
index 000000000..49f62fc5c
--- /dev/null
+++ b/doc/rst/legacy/reference/fc_getslotlist/index.rst
@@ -0,0 +1,69 @@
+.. _mozilla_projects_nss_reference_fc_getslotlist:
+
+FC_GetSlotList
+==============
+
+`Name <#name>`__
+~~~~~~~~~~~~~~~~
+
+.. container::
+
+ FC_GetSlotList - Obtain a list of slots in the system.
+
+`Syntax <#syntax>`__
+~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ .. code:: eval
+
+ CK_RV FC_GetSlotList(
+ CK_BBOOL tokenPresent,
+ CK_SLOT_ID_PTR pSlotList,
+ CK_ULONG_PTR pulCount
+ );
+
+`Parameters <#parameters>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``tokenPresent``
+ [in] If true only slots with a token present are included in the list, otherwise all slots are
+ included.
+ ``pSlotList``
+ [out] Either null or a pointer to an existing array of ``CK_SLOT_ID`` objects.
+ ``pulCount``
+ [out] Pointer to a ``CK_ULONG`` variable which receives the slot count.;
+
+`Description <#description>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``FC_GetSlotList`` obtains a list of slots in the system.
+
+ A user may call ``FC_GetSlotList`` without logging into the token (to assume the NSS User role).
+
+.. _return_value:
+
+`Return value <#return_value>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``CKR_OK``
+
+`Examples <#examples>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+.. _see_also:
+
+`See also <#see_also>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ - `NSC_GetSlotList </en-US/NSC_GetSlotList>`__ \ No newline at end of file