Context.CheckCancelled Method

Throws an exception if the query has timed out or been canceled by the user.

Namespace:  Microsoft.AnalysisServices.AdomdServer
Assembly:  msmgdsrv (in msmgdsrv.dll)

Syntax

'Declaration
Public Shared Sub CheckCancelled
'Usage
Context.CheckCancelled()

public static void CheckCancelled()

public:
static void CheckCancelled()

static member CheckCancelled : unit -> unit

public static function CheckCancelled()

Remarks

The exception raised by CheckCancelled should be handled, and then rethrown.

Examples

In the following example, a UDF is defined that takes a very long time to execute. Occasionally, it calls CheckCancelled to determine if the function should exit:

public string LongRunning()
{

    try
    {
        //Enter a long running loop
        for (int nIndex = 0; nIndex < 1000; nIndex++)
        {
            //Exception generated when the query is canceled or Timeout occurs
            Context.CheckCancelled();
            System.Threading.Thread.Sleep(1000);
        }
    }
    catch (System.Exception ex)
    {
        Console.WriteLine(ex.Message);
        throw ex;
    }

    return "UDF Allowed to Finish";
}

See Also

Reference

Context Class

Microsoft.AnalysisServices.AdomdServer Namespace