C++ Syntax

bool

MKI_InputParameterProc(

__int32 f_nCommandID,

__int32 f_nMode );

typedef void

(*MKI_INPUTPARAMETER_PROC)(

__int32 f_nCommandID,

__int32 f_nMode );

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.

Mode New in Version 6.60

[__int32] Execution mode. If zero, the procedure should only return an indication whether the given command has parameters. If non-zero, the parameter editing dialog should be displayed.

Return Value

Should return true to indicate that either the command has parameters (if Mode is zero) or that changes in the parameter dialog require a re-start of the command (if Mode is non-zero). This re-start will then automatically be done by the serving application. If false is returned, the serving application continues like this procedure had never been called.

Comment

This procedure is frequently called with a Mode of zero to determine whether a command's icon must be supplied with a "parameters available" symbol.

Furthermore, it is called with a Mode of non-zero each time the application's command "Change Parameters" is called. In most cases, it might be useful to also call this procedure from within the plug-in before starting a command's execution. The command itself should then only be started if the user does not cancel the dialog.

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