JavaScript Functions > Alphabetical Listing of Utility Functions (lr) > lr.zip

lr.zip

Compresses the information in a parameter and stores the compressed information in another parameter.

ExampleString and Parameter Functions

Syntax

lr.zip ( "source=<parameter name>", "target=<parameter name>" );

Arguments

ArgumentComments
source The name of the parameter containing the information to be compressed.
targetThe name of the parameter to store the compressed information.

lr.zip compresses the information in a parameter and stores the compressed information in another parameter.

Return Values

Returns LR_FAIL if the source parameter does not exist or if the compression fails.

Parameterization

Standard parameterization does not apply to this function.

Example

function Action(){
    lr.saveString("This is the text I want to zip.","param1");
    lr.zip("target=param2", "source=param1");
    lr.zip("source=param1", "target=param3");
    lr.unzip("source=param3", "target=param4" );

    lr.outputMessage(lr.evalString("{param4}"));
   
   return 0;
}