<doc>
  <legacy_id>3013</legacy_id>
  <name>revZipDescribeItem</name>
  <type>function</type>
  <syntax>
    <example>revZipDescribeItem(<i>archivePath, itemName</i>)</example>
  </syntax>
  <library>Zip Library</library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Text and Data Processing</category>
  </classification>
  <references>
    <command tag="revZipDeleteItem">revZipDeleteItem Command</command>
  </references>
  <history>
    <introduced version="2.7.3">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
    <disk access="???"/>
    <network/>
  </security>
  <summary>Returns information about an item in a zip archive.</summary>
  <examples>
    <example>put revZipDescribeItem(tArchive, "myZippedItem") into tDetails</example>
    <example>put item 6 of revZipDescribeItem(tArchive, "myZippedItem") into tCompressionMethod</example>
  </examples>
  <description>
    <p>Use the <b>revZipDescribeItem</b> function to obtain detailed information about a given item in an open zip archive. The archive must first have been opened using the <command tag="revZipOpenArchive">revZipOpenArchive</command> command.</p><p/><p><b>Parameters:</b></p><p>The <i>archivePath</i> is the absolute path to the archive containing the item to describe.</p><p>The <i>itemName</i> is the name of the item to describe in the archive.</p><p/><p><b>Value:</b></p><p>This function returns a comma delimited list of details in the form:</p><p><i>index</i>, <i>crc</i>, <i>size</i>, <i>mtime</i>, <i>compressed_size</i>, <i>compression_method</i></p><p>    </p><p>Where:</p><p><i>  index</i> is the unique number of the item in the archive</p><p><i>  crc</i> is the checksum of the item a 32-bit integer</p><p><i>  size</i> is the size in bytes of the item</p><p><i>  mtime</i> is the last modified time, in seconds since the Unix Epoch (0:00 on the 1st Jan 1970)</p><p><i>  compressed_size</i> is the size of the item after compression</p><p><i>  compression_method</i>  is the type of compression used, and is one of:</p><p><i>    none</i></p><p><i>    shrink</i></p><p><i>    reduce_1</i></p><p><i>    reduce_2</i></p><p><i>    reduce_3</i></p><p><i>    reduce_4</i></p><p><i>    implode</i></p><p><i>    deflate</i></p><p><i>    deflate64</i></p><p><i>    pkware_implode</i></p><p/><p>The result will be set to the same as the return value of the function.</p><p/><p><b>Note:</b> While the Zip library can read most archives, extracting files from archives is only supported for files compressed with the method <i>deflate</i>.</p>
  </description>
</doc>