summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_getobjectsize/index.rst
blob: c2bf40cc51f380953b842abe382d5c145203e823 (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_getobjectsize:

FC_GetObjectSize
================

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

.. container::

   FC_GetObjectSize - create a copy of an object.

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

.. container::

   .. code::

      CK_RV FC_GetObjectSize(
        CK_SESSION_HANDLE hSession,
        CK_OBJECT_HANDLE hObject,
        CK_ULONG_PTR pusSize
      );

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

.. container::

   ``hSession``
      [in] session handle.
   ``hObject``
      [in] object handle.
   ``pusSize``
      [out] pointer to location to receive the object's size.

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

.. container::

   ``FC_GetObjectSize`` gets the size of an object in bytes.

   A user must log into the token (to assume the NSS User role) before getting the size of a secret
   or private key object.

.. _return_value:

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

.. container::

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

.. container::

.. _see_also:

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

.. container::

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