summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_generaterandom/index.rst
blob: 926102f60b7433c0a6e3eb6c634d4c95f54aae39 (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
.. _mozilla_projects_nss_reference_fc_generaterandom:

FC_GenerateRandom
=================

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

.. container::

   FC_GenerateRandom - generate a random number.

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

.. container::

   .. code:: eval

      CK_RV FC_GenerateRandom(
        CK_SESSION_HANDLE hSession,
        CK_BYTE_PTR pRandomData,
        CK_ULONG ulRandomLen
      );

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

.. container::

   ``hSession``
      [in] session handle.
   ``pRandomData``
      [out] pointer to the location to receive the random data.
   ``ulRandomLen``
      [in] length of the buffer in bytes.

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

.. container::

   ``FC_GenerateRandom`` generates random data of the specified length.

   A user may call ``FC_GenerateRandom`` without logging into the token (to assume the NSS User
   role).

.. _return_value:

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

.. container::

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

.. container::

.. _see_also:

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

.. container::

   -  `NSC_GenerateRandom </en-US/NSC_GenerateRandom>`__