summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_findobjectsinit/index.rst
blob: cbd9a59fa3be186f6483fa775e7dceef44376b64 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.. _mozilla_projects_nss_reference_fc_findobjectsinit:

FC_FindObjectsInit
==================

`Name <#name>`__
~~~~~~~~~~~~~~~~

.. container::

   FC_FindObjectsInit - initialize the parameters for an object search.

`Syntax <#syntax>`__
~~~~~~~~~~~~~~~~~~~~

.. container::

   .. code::

      CK_RV FC_FindObjectsInit(
        CK_SESSION_HANDLE hSession,
        CK_ATTRIBUTE_PTR pTemplate,
        CK_ULONG usCount
      );

`Parameters <#parameters>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   ``hSession``
      [in] session handle.
   ``pTemplate``
      [in] pointer to template.
   ``usCount``
      [in] number of attributes in the template.

`Description <#description>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   ``FC_FindObjectsInit`` sets the attribute list for an object search. If ``FC_FindObjectsInit`` is
   successful ``FC_FindObjects`` may be called one or more times to retrieve handles of matching
   objects.

   A user must log into the token (to assume the NSS User role) before searching for secret or
   private key objects.

.. _return_value:

`Return value <#return_value>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

`Examples <#examples>`__
~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

.. _see_also:

`See also <#see_also>`__
~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   -  :ref:`mozilla_projects_nss_reference_fc_findobjects`,
      `NSC_FindObjectsInit </en-US/NSC_FindObjectsInit>`__