Context.CheckCancelled Method

Article
12/03/2008

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

public static void CheckCancelled ()

public:
static void CheckCancelled ()

public static void CheckCancelled ()

public static function CheckCancelled ()

Remarks

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

Example

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";
}

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms