ssCore.Crypto.encryptFile

Encrypt a file.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

key - The string that will be used to encrypt the file. You will also need this key to decrypt the file later.

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

destination - A fully qualified path to the encrypted 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.encryptFile( 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.encryptFile( paramsObject );


Notes:

None.


Examples:

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