Management Functions > VpeDispatchAllMessages

[Windows platform only]

Needs to be called regularly to allow the user to browse in the preview through an open document while your application is still generating the report (i.e. adding objects and pages). See "Multipage Documents" and "Generating a Document while the Preview is open" in the Programmer's Manual for details.

int VpeDispatchAllMessages(

VpeHandle hDoc

)

VpeHandle hDoc

Document Handle

Returns:

The method returns True, if the preview - or the parent window of the preview - are closed by the user. In such a case you should perform the necessary cleanup (for example close tables and databases) and exit the function that creates the report immediately. You may not call any VPE function of the related document, if this function returns True.

The method returns False, if the preview or the parent window of the preview are NOT closed by the user.

Remarks:

Never call VpeDispatchAllMessages() while processing a VPE Event!