Dialog::SetIgnoreKeyCode

Defined in: C4Dialog.h

Returns the key code that triggers the ignore button.

Prototype

void SetIgnoreKeyCode(uint32 code);

Parameters

code The key code that triggers the ignore button.

Description

The SetIgnoreKeyCode function sets the key code that causes the ignore button to be triggered to that specified by the code parameter. If the key code is zero (the default value), then no key triggers the ignore button. Otherwise, the ignore button is triggered when the key is pressed, even if no text was originally specified for the ignore button, the status returned by the Dialog::GetDialogStatus function is set to kDialogIgnore, and the dialog is closed.