ReportViewer.CancelRendering Method (Int32)

  • Article

 

Stops background processing of the report.

Namespace:   Microsoft.Reporting.WinForms
Assembly:  Microsoft.ReportViewer.WinForms (in Microsoft.ReportViewer.WinForms.dll)

Syntax

public bool CancelRendering(
    int millisecondsTimeout
)

public:
bool CancelRendering(
    int millisecondsTimeout
)

member CancelRendering : 
        millisecondsTimeout:int -> bool

Public Function CancelRendering (
    millisecondsTimeout As Integer
) As Boolean

Parameters

  • millisecondsTimeout
    Type: System.Int32

    The number of milliseconds to wait for the background rendering to terminate. A value of -1 waits forever. A value of 0 returns immediately without waiting for the rendering to terminate.

Return Value

Type: System.Boolean

A Boolean value. A value of true is returned if the background rendering has terminated. A value of false is returned if background rendering has not terminated after the amount of time specified in the millisecondsTimeout parameter has elapsed, or if the millisecondsTimeout parameter was set to 0.

See Also

ReportViewer Class
Microsoft.Reporting.WinForms Namespace

Return to top