<doc>

<legacy_id>1506</legacy_id>

<name>decompress</name>

<type>function</type>

<syntax>

<example>decompress(<i>gzippedString</i>)</example>

<example>the decompress of <i>gzippedString</i></example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>Text and Data Processing</category>

</classification>

<references>

<function tag="base64Decode">base64Decode Function</function>

<function tag="compress">compress Function</function>

<function tag="URLDecode">URLDecode Function</function>

</references>

<history>

<introduced version="1.0">Added.</introduced>

</history>

<platforms>

<mac/>

<windows/>

<linux/>

<ios/>

<android/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

<mobile/>

</classes>

<security>

</security>

<summary><glossary tag="return">Returns</glossary> the plain text of a gzip-encoded <keyword tag="string">string</keyword>.</summary>

<examples>

<example>decompress(receivedString)</example>

<example>put decompress(it) into URL "file:data.txt"</example>

<example>go stack decompress(URL "binfile:newstuff.gz")</example>

</examples>

<description>

<p>Use the <b>decompress</b> <control_st tag="function">function</control_st> to regain the original data that was <glossary tag="compress">compressed</glossary>.</p><p/><p><b>Parameters:</b></p><p>The <i>data</i> is a <keyword tag="string">string</keyword> of <glossary tag="compress">compressed</glossary> <glossary tag="binary data">binary data</glossary>.</p><p/><p><b>Value:</b></p><p>The <b>decompress</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> a <keyword tag="string">string</keyword>.</p><p/><p><b>Comments:</b></p><p>The<b> decompress</b> <control_st tag="function">function</control_st> is the <keyword tag="inverse">inverse</keyword> of the <function tag="compress">compress</function> <control_st tag="function">function</control_st>.</p><p/><p>The uncompressed result is typically about half again the size of the compressed data, although different results may be obtained depending on the amount of data.</p><p/><p>For technical information about the format used by the <b>compress</b> and <b>decompress</b> <glossary tag="function">functions</glossary>, see RFC 1952 at &lt;<u>http://www.ietf.org/rfc/rfc1952.txt</u>&gt;. The <b>decompress</b> <control_st tag="function">function</control_st> uses the zlib compression library.</p>

</description>

</doc>