C++ Syntax

__int32

MKI_InputCancelProc(

__int32 f_nCommandID,

__int32 f_nPointCount );

typedef __int32

(*MKI_INPUTCANCEL_PROC)(

__int32 f_nCommandID,

__int32 f_nPointCount );

This procedure is called during the execution of an external command, i.e. a command that is handled by a plug-in.

Parameters

CommandID

[__int32] Identifier of the current command. Valid range: 0 <= Value < MKI_PLUGIN_MENU_MAX.

PointCount

[__int32] Number of points that have already been entered. Valid range: 0 <= Value < MKI_INPUT_MAX.

Return Value

Should return one of the following values:

MKI_INPUT_OK

Continue the entry of the current point after calling MKI_InputPointInitProc again to update calculations (usually if the user altered parameters for the current point).

MKI_INPUT_IGNORE

Ignore the pressing of the right mouse button, i.e. continue the entry of the current point.

MKI_INPUT_CANCEL

Cancel the complete command (usually due to user termination).

MKI_INPUT_FINISH

Finish the command, i.e. call MKI_InputFinishProc.

Comment

This procedure is called if the user presses the right mouse button to cancel the command during point entry. The procedure will only be called if the command requires a variable number of point entries (i.e. if the value InputData.CommandMode value of the MKI_COMMAND_DATA structure was set to COMMAND_VARIABLE) and if at least one point has already been entered. At this time, the plug-in should e.g. ask whether to terminate the point entry (either canceling or finishing the command) or to edit parameters of the current point.

The name MKI_InputCancelProc is only a placeholder, the procedure may have any name.