ssCore.Compress.deflateFile

Deflate (compress) a file.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

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

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


Notes:

None.


Examples:

The following example will deflate (compress) an XML file that is located next to the application. The deflated version of the file will be created in the same folder but will have a different extension.

ssCore.Compress.deflateFile({source:"startdir://file.xml", destination:"startdir://file.dat"});