Terminating an Enterfunction

Enterfunctions are terminated in one of several ways. All enterfunctions can be canceled, by calling cancelEnterFun, or finished, by calling finishEnterFun. When an enterfunction is canceled, all data entered is lost and nil is returned. When it is finished, the data entered is returned as the result of the enterfunction.

Do NOT use the return value of the enterfunction to gather data but to register a callback procedure for this purpose. Enterfunctions will no longer block in future releases, and the return value will indicate only that the enterfunction was successfully started.

Enterfunctions that take a specific number of points, such as enterArc or enterBox, are automatically terminated when the last point is entered. Functions that take a variable number of points are terminated automatically only when two identical points are entered. Otherwise, enterfunctions are terminated only with an explicit call to finishEnterFun or cancelEnterFun. If a pointlist is passed for preloading to an enterfunction that requires a variable number of points, the enterfunction returns without further interaction if the last two points in the list are identical.

Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023