summaryrefslogtreecommitdiffstats
path: root/security/nss/doc/rst/legacy/reference/fc_setpin
diff options
context:
space:
mode:
Diffstat (limited to 'security/nss/doc/rst/legacy/reference/fc_setpin')
-rw-r--r--security/nss/doc/rst/legacy/reference/fc_setpin/index.rst75
1 files changed, 75 insertions, 0 deletions
diff --git a/security/nss/doc/rst/legacy/reference/fc_setpin/index.rst b/security/nss/doc/rst/legacy/reference/fc_setpin/index.rst
new file mode 100644
index 0000000000..83ef6f17db
--- /dev/null
+++ b/security/nss/doc/rst/legacy/reference/fc_setpin/index.rst
@@ -0,0 +1,75 @@
+.. _mozilla_projects_nss_reference_fc_setpin:
+
+FC_SetPIN
+=========
+
+`Name <#name>`__
+~~~~~~~~~~~~~~~~
+
+.. container::
+
+ FC_SetPIN - Modify the user's PIN.
+
+`Syntax <#syntax>`__
+~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ .. code::
+
+ CK_RV FC_SetPIN(
+ CK_SESSION_HANDLE hSession,
+ CK_CHAR_PTR pOldPin,
+ CK_ULONG ulOldLen,
+ CK_CHAR_PTR pNewPin,
+ CK_ULONG ulNewLen
+ );
+
+`Parameters <#parameters>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``FC_SetPIN`` takes five parameters:
+
+ ``hSession``
+ [Input] the session's handle
+ ``pOldPin``
+ [Input] points to the old PIN.
+ ``ulOldLen``
+ [Input] the length in bytes of the old PIN.
+ ``pNewPin``
+ [Input] points to the new PIN.
+ ``ulNewLen``
+ [Input] the length in bytes of the new PIN.
+
+`Description <#description>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``FC_SetPIN`` modifies the PIN of the user. The user must log into the token (to assume the NSS
+ User role) before calling ``FC_SetPIN``.
+
+.. _return_value:
+
+`Return value <#return_value>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``CKR_OK``
+
+`Examples <#examples>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+.. _see_also:
+
+`See also <#see_also>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ - `NSC_SetPIN </en-US/NSC_SetPIN>`__ \ No newline at end of file