Share via


PFN_KEYBD_DRIVER_GET_INFO (Compact 2013)

3/26/2014

The function based on this prototype retrieves information about the keyboard and the driver.

Syntax

typedef BOOL (*PFN_KEYBD_DRIVER_GET_INFO)(
  INT iKeybdId,
  INT iIndex,
  LPVOID lpOutput
);

Parameters

Parameter

Description

iKeybdId

[in] Ignored.

iIndex

[in] Identifier of the information to retrieve.

The following table shows the identifiers and their descriptions.

IdentifierDescription
KBDI_VKEY_TO_UNICODE_INFO_IDIf iIndex is KBDI_VKEY_TO_UNICODE_INFO_ID, lpOutput must point to a KBDI_VKEY_TO_UNICODE_INFO structure.
KBDI_AUTOREPEAT_INFO_IDReturns the auto-repeat settings that apply to all keyboards. If iIndex is KBDI_AUTOREPEAT_INFO_ID, lpOutput must point to a KBDI_AUTOREPEAT_INFO structure.
KBDI_AUTOREPEAT_SELECTIONS_INFO_IDReturns various minimums and maximums related to the auto-repeat rate. If iIndex is KBDI_AUTOREPEAT_SELECTIONS_INFO_ID, lpOutput must point to an array of the following INT32 values:
  • Minimum delay before starting auto-repeat, in milliseconds.
  • Maximum delay before starting auto-repeat, in milliseconds.
  • Minimum auto-repeat rate, in keys per second.
  • Maximum auto-repeat rate, in keys per second.

lpOutput

[out] Pointer to the output buffer. The size of the buffer that must be available at this address depends on iIndex.

Return Value

TRUE indicates success. FALSE indicates failure. To obtain extended error information, call GetLastError.

Remarks

This function must be re-entrant because the Graphics, Windowing, and Events Subsystem (GWES) exposes it through the KeybdGetDeviceInfo function and multiple threads can call it.

Requirements

Header

keybddr.h

Library

layoutmanager.lib

See Also

Reference

Keyboard Driver MDD Functions
KBDI_AUTOREPEAT_INFO
KBDI_VKEY_TO_UNICODE_INFO

Other Resources

KeybdGetDeviceInfo