This chapter provides reference material for the password API. The password API is declared in the header file Password.h
.
Password Functions
PwdExists Function
Purpose
Return true
if the system password is set.
Declared In
Password.h
Prototype
Boolean PwdExists()
Parameters
Returns
Returns true
if the system password is set.
PwdRemove Function
Purpose
Remove the encrypted password string and recover data hidden in databases.
Declared In
Password.h
Prototype
void PwdRemove ( void )
Parameters
Returns
PwdSet Function
Purpose
Use a passed string as the new password. The password is stored in an encrypted form.
Declared In
Password.h
Prototype
void PwdSet ( Char *oldPassword, Char *newPassword )
Parameters
-
oldPassword
- The old password must be successfully verified or the new password isn't accepted
-
newPassword
-
Char*
to a string to use as the password.NULL
means no password.
Returns
PwdVerify Function
Purpose
Verify that the string passed matches the system password.
Declared In
Password.h
Prototype
Boolean PwdVerify ( Char *string )
Parameters
-
string
- String to compare to the system password.
NULL
means no current password. - The allocated length of string must be at least
pwdLength
characters long.
Returns
Returns true
if the string matches the system password.