====== zprogbox_ShowWnd ======

===== Description =====

Displays a progress bar window.

===== Files =====

^ Declaration | ''Zeolite.h'' |
^ Implementation | ''Zeolite.cpp'' |

===== Function prototype =====

<code="C++">
bool zprogbox_ShowWnd(ZVAR hProgWnd, unsigned long Flags);
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //hProgWnd//  |  ''ZVAR''  | A [[zeolite:types:ZVAR]] handle of type VarID_progbox. |
|  //Flags//  |  unsigned long  | An unsigned long integer containing a bitwise combination of flags. See comments for supported flag values. |

===== Return value =====

False if an error has occurred, and true otherwise.

===== Comments =====

==== Flag values ====

The following flag values are defined in ''Zeolite_defines.h'':

^ Symbol ^  Flag bit  ^ Description ^
| ZPROGBOX_SHOW_PERCENT  |  0x1  | Show the progress as a percentage in the progress window title. |
| ZPROGBOX_INDEFINITE  |  0x2  | Show an indefinite scrolling progress bar.  |
| ZPROGBOX_ALLOW_CANCEL  |  0x4  | Include a cancel button in the progress window. If cancel is pressed, subsequent calls to [[zeolite:functions:zprogbox_SetProgress]] will return ''false''. |