◆ KeyGet()

int32_t KeyGet ( int32_t milliseconds )

Description:: KeyGet returns the value of the key pressed.

Parameters

milliseconds The number of milliseconds to wait for the key to be pressed.
Use RSIWaitFOREVER (-1) to wait forever.
Use RSIWaitPOLL (0) to return immediately.

Returns: (int32_t) -1 = no key was pressed, or value of ASCII character.

Remarks: This function is also available in RapidSequencer.

Sample Code:: while (controller->KeyGet(RSIWaitPOLL) < 0)

{

// waiting for someone to press a key

}

RSI::RapidCode::RSIWait::RSIWaitPOLL
@ RSIWaitPOLL
return immediately, use polling

Examples: ControllerInterrupts.cpp, SyncInterrupt.cpp, and UserLimitDigitalInputAction.cpp.