get_is_cancelled

Use the get_is_cancelled v4 API method to determine whether the statement has been cancelled.

Declaration

 short get_is_cancelled(
		a_v4_extfn_proc_context *          cntxt,
		
		)

Usage

If a UDF entry point is performing work for an extended period of time (many seconds), it should, if possible, call the get_is_cancelled callback every second or two to see if the user has interrupted the current statement. If the statement has been interrupted, a nonzero value is returned and the UDF entry point should then immediately return. Call the _finish_extfn function to perform necessary cleanup. Do not subsequently call any other UDF entry points.

Parameters

Parameter Description
cntxt The procedure context object.

Returns

A nonzero value, if the statement is interrupted.