Share via


PFN_KEYBD_DRIVER_INIT_STATES (Compact 2013)

3/26/2014

The function based on this prototype initializes the virtual-key code state and driver-specific state.

Syntax

typedef BOOL (*PFN_KEYBD_DRIVER_INIT_STATES)(
  INT iKeybdId,
  KEY_STATE KeyState,
  void *pKeybdDriverState
);

Parameters

  • iKeybdId
    [in] Identifier of the keyboard to initialize key state data.
  • KeyState
    [out] Key state to initialize.
  • pKeybdDriverState
    [in] Keyboard-specific state to initialize.

Return Value

None.

Remarks

After calling the PFN_KEYBD_DRIVER_GET_INFO function and allocating its required memory, the input system calls this function to enable the driver to initialize the memory.

The pKeybdDriverToUnicodeState parameter is a pointer to a block of memory of at least cbToUnicodeState bytes, as reported by the PFN_KEYBD_DRIVER_GET_INFO function in the KBDI_VKEY_TO_UNICODE_INFO structure. If cbToUnicodeState is reported as zero, this parameter can be NULL.

This function must be re-entrant because the input system exposes it through the PFN_KEYBD_DRIVER_INIT_STATES function and multiple threads can call it.

Requirements

Header

keybddr.h

Library

layoutmanager.lib

See Also

Reference

Keyboard Driver MDD Functions
KBDI_VKEY_TO_UNICODE_INFO
PFN_KEYBD_DRIVER_GET_INFO