KbdGetConsole - Parameters

Data (PVOID) - output

Pointer to event data.

A pointer to a location where the event data is returned. The data type returned depends on the kind of event returned. For keyboard events, the data type returned is KBDKEYINFO. For mouse events, the data type returned is MOUQUEINFO.

Kind (PULONG) - output

Kind of event returned.

One of the following values is returned:

• No event available 1
  Keyboard event (not a valid character)
  2
  Character
  3
  Mouse event
  4
  Notification

  Flag (ULONG) - input

  Wait for a keystroke flag.

  The possible values are:

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

  hkbd (HKBD) - input

  Reserved. Must be 0.

  return (APIRET) - returns

  Return code.

  KbdGetConsole returns one of the following values:

  • NO_ERROR. 375
    ERROR_KBD_INVALID_HANDLE
    439
    ERROR_KBD_INVALID_IOWAIT
    464
    ERROR_KBD_DETACHED

    ---

    [Back: KbdGetConsole Return Value - return]
    [Next: KbdGetConsole - Remarks]