cacheFilePassword (method)

Caches an encryption password to use the next time a file or alternate stream is accessed.

Syntax

- (void)cacheFilePassword:(NSString*)fileName :(NSString*)password;
public func cacheFilePassword(_ fileName: String, _ password: String) throws -> Void

Remarks

This temporarily caches an encryption password so that it can be used the next time the file or alternate stream specified by FileName is accessed. The specified password is automatically removed from the cache as soon as one of the following things occur:

  • The password is used to access the file or alternate stream.
  • The password for the file or alternate stream is changed.
  • The vault is closed.

The value passed for FileName must be a vault-local absolute path.

The Password parameter specifies the password to cache. It must match the one last used to encrypt the specified file or alternate stream, otherwise this method .

As an alternative to using this method, applications can provide a default file encryption password using the DefaultFilePassword property, and/or provide such passwords dynamically using the FilePasswordNeeded event.

Note: This method can only be called when Active is true.
Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Storage 2020 iOS Edition - Version 20.0 [Build 8031]