diff options
author | Benjamin Beurdouche <bbeurdouche@mozilla.com> | 2022-01-28 19:34:47 +0100 |
---|---|---|
committer | Benjamin Beurdouche <bbeurdouche@mozilla.com> | 2022-01-28 19:34:47 +0100 |
commit | 0bc3a823701633901130766e83684ae4e13096d4 (patch) | |
tree | 18b7786784893ea62fa873e7d1fd316617b1dc1f /doc/rst/legacy/reference/fc_encrypt/index.rst | |
parent | 1378f8355e07050e9cbd6e44a87af86cbef5c972 (diff) | |
download | nss-hg-0bc3a823701633901130766e83684ae4e13096d4.tar.gz |
Documentation: import legacy documentation from MDN
Differential Revision: https://phabricator.services.mozilla.com/D137312
Diffstat (limited to 'doc/rst/legacy/reference/fc_encrypt/index.rst')
-rw-r--r-- | doc/rst/legacy/reference/fc_encrypt/index.rst | 73 |
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 |