ssCore.Crypto.decryptFile

Decrypt a file.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

key - This same key you used to encrypt the file.

source - A fully qualified path to the encrypted file. This parameter supports monikers.

destination - A fully qualified path to the decrypted file. If the file exists it will be overwritten. If the file does not exist it will be created. This parameter supports monikers.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Crypto.decryptFile( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Crypto.decryptFile( paramsObject );


Notes:

None.


Examples:

The following example will decrypt a file that was previously encrypted with ssCore.Crypto.encryptFile. A file called file.dat next to the application will be decrypted using the same key we used to encrypt the file. The decrypted file will be renamed.

ssCore.Crypto.decryptFile({source:"startdir://file.dat", destination:"startdir://file.xml", key:"secret01"});