Share this page

# lr_zip

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

    int lr_zip ( "source=<parameter  name>", "target=<parameter name>" );

Alphabetical Listing - C Language Utility Functions

## Arguments

Name | Comments
--- | ---
source | The name of the parameter containing the information to be compressed.
target | The 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_PASS on success.

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

In this example, lr_zip is used to compress and store the string in a parameter. lr_zip is called twice to show that the order of the parameters is not important.

lr_unzip is then called to uncompress the data.

    lr_save_string("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");

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: