summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_encrypt/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rst/legacy/reference/fc_encrypt/index.rst')
-rw-r--r--doc/rst/legacy/reference/fc_encrypt/index.rst73
1 files changed, 73 insertions, 0 deletions
diff --git a/doc/rst/legacy/reference/fc_encrypt/index.rst b/doc/rst/legacy/reference/fc_encrypt/index.rst
new file mode 100644
index 000000000..c57c22545
--- /dev/null
+++ b/doc/rst/legacy/reference/fc_encrypt/index.rst
@@ -0,0 +1,73 @@
+.. _mozilla_projects_nss_reference_fc_encrypt:
+
+FC_Encrypt
+==========
+
+`Name <#name>`__
+~~~~~~~~~~~~~~~~
+
+.. container::
+
+ FC_Encrypt - Encrypt a block of data.
+
+`Syntax <#syntax>`__
+~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ .. code:: eval
+
+ CK_RV FC_Encrypt(
+ CK_SESSION_HANDLE hSession,
+ CK_BYTE_PTR pData,
+ CK_ULONG usDataLen,
+ CK_BYTE_PTR pEncryptedData,
+ CK_ULONG_PTR pusEncryptedDataLen
+ );
+
+`Parameters <#parameters>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``hSession``
+ [in] session handle.
+ ``pData``
+ [in] pointer to the data buffer
+ ``usDataLen``
+ [in] length of the data buffer in bytes.
+ ``pEncryptedData``
+ [out] pointer to location where encrypted data is to be stored.
+ ``pusEncryptedDataLen``
+ [in/out] number of bytes.
+
+`Description <#description>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``FC_Encrypt`` encrypts a block of data according to the attributes of the previous call to
+ ``FC_EncryptInit``.
+
+ A user must log into the token (to assume the NSS User role) before calling ``FC_Encrypt``.
+
+.. _return_value:
+
+`Return value <#return_value>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+`Examples <#examples>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+.. _see_also:
+
+`See also <#see_also>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ - :ref:`mozilla_projects_nss_reference_fc_encryptinit`, `NSC_Encrypt </en-US/NSC_Encrypt>`__ \ No newline at end of file