IdxSpreadSheetProtectionInfo.CheckPassword(string) Method

Identifies if the hash calculated for the specified password matches the hash stored by a particular spreadsheet protection provider.

Declaration

function CheckPassword(const APassword: string): Boolean;

Parameters

Name	Type
APassword	string

Returns

Type
Boolean

Remarks

Normally, this function supports the internal infrastructure and is not intended to be used directly from your code. The CheckPassword function is called internally by:

• The Spreadsheet control‘s Unprotect procedure;

• The Table View worksheet’s Unprotect procedure.

The CheckPassword function returns True if the hash value calculated for the password passed as the APassword parameter is identical to the hash value of the password used by a spreadsheet protection provider. Otherwise, the function returns False.

The CheckPassword function can use various hash calculation algorithms for password verification, depending on which protection provider (i.e., an instance of the TdxSpreadSheetCustomProtectionInfo class descendant assigned to the OptionsProtection.ProtectionInfo property) is currently active and the protection provider settings, if applicable.