KbdCharIn - Parameters

CharData (PKBDKEYINFO) - output

Pointer to character data.

A pointer to a KBDKEYINFO structure in which the character data is returned.

Wait (ULONG) - input

Wait Flag.
• IO_WAIT Wait for a keystroke if one is not available. The keystroke returned is removed from the queue.
  
• IO_NOWAIT
  Return immediately, with or without a keystroke. If a keystroke is returned, remove it from the queue.
  
• IO_PEEK
  Return immediately, with or without a keystroke. Do not remove the keystroke from the queue.
  
• IO_PEEKWAIT
  Wait for a keystroke if one is not available. Return the keystroke but do not remove it from the queue.

hkbd (HKBD) - input

Reserved. Must be 0.

rc (APIRET) - returns

Return code.

KbdCharIn returns one of the following values:

• NO_ERROR 375
  ERROR_KBD_INVALID_IOWAIT
  445
  ERROR_KBD_FOCUS_REQUIRED
  447
  ERROR_KBD_KEYBOARD_BUSY
  504
  ERROR_KBD_EXTENDED_SG

  ---

  [Back: KbdCharIn Return Value - rc]
  [Next: KbdCharIn - Remarks]