PFN_KEYBD_DRIVER_SET_MODE

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/28/2008

The function based on this prototype sets auto-repeat information for the keyboard device.

Syntax

typedef BOOL (*PFN_KEYBD_DRIVER_SET_MODE)(
  INT iKeybdId,
  INT iIndex,
  LPVOID lpInput
);

Parameters

• iKeybdId
  [in] Ignored.

• ** iIndex **
  **** For Windows Embedded CE:** **

  [in] Identifier to set keyboard auto-repeat information or not. Set to the KBDI_AUTOREPEAT_INFO_ID to set auto-repeat information. If set to KBDI_AUTOREPEAT_INFO_ID, lpInput must point to a KBDI_AUTOREPEAT_INFO structure.**

• ** iIndex **
  **** For Windows Mobile:** **

  [in] Identifier of the information to set.

  The following table shows the identifiers and their descriptions.

  Identifier	Description
  KBDI_AUTOREPEAT_INFO_ID	Identifier to set keyboard auto-repeat information. If set to KBDI_AUTOREPEAT_INFO_ID, lpInput must point to a KBDI_AUTOREPEAT_INFO structure.
  KBDI_SHIME_MODE_ID	Identifier to notify the keyboard driver of the desired IME mode. If set to KBDI_SHIME_MODE_ID, lpInput must be set to one of the following values. 0x0000 KBDI_SHIME_MODE_NONE 0x0001 KBDI_SHIME_MODE_SPELL 0x0002 KBDI_SHIME_MODE_SPELL_CAPS 0x0003 KBDI_SHIME_MODE_SPELL_CAPS_LOCK 0x0004 KBDI_SHIME_MODE_AMBIGUOUS 0x0005 KBDI_SHIME_MODE_AMBIGUOUS_CAPS 0x0006 KBDI_SHIME_MODE_AMBIGUOUS_CAPS_LOCK 0x0007 KBDI_SHIME_MODE_NUMBERS 0x0008 KBDI_SHIME_MODE_CUSTOM

• lpInput
  [in] Pointer to an input buffer. iIndex controls the format of the buffer.

Return Value

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

Remarks

For All Platforms

This function sets the auto-repeat settings that apply to every keyboard. The keyboard identifier is ignored. This method can cause a IOCTL_HID_SET_AUTOREPEAT to be sent to human interface device (HID) keyboards.

This function is called by GWES in response to an application making a call to NotifyWinUserSystem with NWUS_KEYBD_REPEAT_CHANGED as a parameter. For more information, see NotifyWinUserSystem.

For Windows Mobile

This function also sets the desired IME mode for the keyboard driver when iIndex is KBDI_SHIME_MODE_ID. For keyboards with number pads, you should turn on the number pad state when lpInput is KBDI_SHIME_MODE_NUMBERS. For keyboards with a SHIFT key, you should set the SHIFT key to down when lpInput is KBDI_SHIME_MODE_SPELL_CAPS or KBDI_SHIME_MODE_AMBIGUOUS_CAPS. For keyboards with a CAPS LOCK key, you should set the CAPS LOCK key to locked when lpInput is KBDI_SHIME_MODE_SPELL_CAPS_LOCK or KBDI_SHIME_MODE_AMBIGUOUS_CAPS_LOCK.**

Requirements

See Also

Reference

KBDI_AUTOREPEAT_INFO
PFN_KEYBD_DRIVER_GET_INFO

Other Resources

NotifyWinUserSystem