DocumentStatus - cWinReport2

Returns the status of a report

Type: Function
Return Data Type: Boolean

Syntax

Function DocumentStatus Returns Boolean

Call Example

Get DocumentStatus to BooleanVariable

Description

DocumentStatus returns the current state of a report and will be one of the following: | Constant | Meaning | |---|---| | dsNotStarted | The document is cleared or has never been started. | | dsStarted | The document has been created, but is not finished. The report is still in progress. | | dsFinished | The document is completed, and is currently valid for viewing or printing. |

This function along with the IsViewerActive function can be used to determine the exact state of a WinPrint2 report. Note that these modes may not be reporting the value of the report returning the message. It returns that state of the global WinPrint2 object.

Note that this reports the status of the global WinPrint2 object (the report engine) and not the status of any individual report object. Since only one report can be in progress (dsStarted or dsFinished) at one time, it is reporting the status of the current or last report run.

Return Value

Returns the report's status