KbdStringIn - Parameters

pch (PCH) - output

Pointer to the character string buffer.

pchin (PSTRINGINBUF) - in/out

Pointer to buffer-length data.

A pointer to the STRINGINBUF structure containing buffer-length data.

Flag (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.

KbdStringIn returns one of the following values:

• NO_ERROR 373
  ERROR_KBD_PARAMETER
  375
  ERROR_KBD_INVALID_IOWAIT
  376
  ERROR_KBD_INVALID_LENGTH
  439
  ERROR_KBD_INVALID_HANDLE
  445
  ERROR_KBD_FOCUS_REQUIRED
  504
  ERROR_KBD_EXTENDED_SG

  ---

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