unlock

Unlocks the vault.

Unlock the vault before changing the its properties or storing anything in it. If the incorrect password or salt is used, this method throws an exception. If the number of unsuccessful unlock attempts exceeds the retry limit, the vault is deleted.

Syntax

- (void)unlock:(NSString*)password withSalt:(NSString*)salt;

Parameters

password – The password.
salt – The encryption salt value.

Returns

If the incorrect password or salt is used, a SUPDataVaultException is thrown this with the reason kDataVaultExceptionReasonInvalidPassword.

Examples

Unlocks the data vault. – Once the vault is unlocked you can change the its properties and stored content.

@try
{
   [oVault unlock:@"password" withSalt:@"salt"];
}
@catch(SUPDataVaultException *e)
{
   NSLog(@"Exception will be thrown for bad password");
}