<doc>
  <legacy_id>3024</legacy_id>
  <name>revZipSetProgressCallback</name>
  <type>command</type>
  <syntax>
    <example>revZipSetProgressCallback [ <i>messageName </i>]</example>
  </syntax>
  <library>Zip Library</library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Text and Data Processsing</category>
  </classification>
  <references>

  </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>Sets a progress callback for zip operations</summary>
  <examples>
    <example>revZipSetProgressCallback "myZipProgressHandler"</example>
    <example>revZipSetProgressCallback</example>
  </examples>
  <description>
    <p>Use the <b>revZipSetProgressCallback</b> command to get information about the progress of zip operations. The message specified will be sent to the current card whenever the status of a zip operation changes.</p><p/><p><b>Parameters:</b></p><p>The <i>messageName </i>is the name of the message that is sent when zip progress changes.</p><p/><p>If the <b>revZipSetProgressCallback</b> command is called without any parameters, then the progress callback will be disabled.</p><p/><p>The progress callback will be called with the following parameters:</p><p><i>  pArchive</i>: the name of the archive being processed</p><p><i>  pItem</i>: the name of the item being processed</p><p><i>  pType</i>: the operation type, either "packing" or "unpacking"</p><p><i>  pItemProgress</i>: the progress of the current item</p><p><i>  pItemTotal</i>: the total progress for the items</p><p><i>  pGlobalProgress</i>: the global progress</p><p><i>  pGlobalTotal</i>: the global total progress</p>
  </description>
</doc>