Skip to main content
ITfFnGetPreferredTouchKeyboardLayout::GetLayout method

Obtains the touch keyboard layout identifier of the layout that the IME directs the touch keyboard to show while the IME is active.

Syntax


HRESULT GetLayout(
  [out]  TKBLayoutType *pTKBLayoutType,
  [out]  WORD *pwPreferredLayoutId
);

Parameters

pTKBLayoutType [out]

Pointer to a TKBLayoutType enumeration that receives the layout type.

pwPreferredLayoutId [out]

Pointer to a WORD value that receives the layout identifier.

Return value

The touch keyboard always expects S_OK.

Remarks

TKBLayoutType is an enumeration with the following values.

TKBLT_UNDEFINEDUndefined.
TKBLT_CLASSIC

The touch keyboard is to use a classic layout.

Classic layouts represent the legacy layouts of physical keyboards.

TKBLT_OPTIMIZED

The touch keyboard is to use a touch-optimized layout.

Touch-optimized layouts have been specifically designed with touch in mind.

 

The layout identifiers returned by this API must be one from the following list. Each identifier is specific to a certain language, and these are all specific to the touch keyboard. There is no way to request support for other layouts, or to add new touch optimized layouts dynamically.

Layout Definition ValueSupported Input Language
TKBL_UNDEFINED0n/a
TKBL_CLASSIC_TRADITIONAL_CHINESE_PHONETIC0x0404CHT
TKBL_CLASSIC_TRADITIONAL_CHINESE_CHANGJIE0xF042CHT
TKBL_CLASSIC_TRADITIONAL_CHINESE_DAYI0xF043CHT
TKBL_OPT_JAPANESE_ABC0x0411JPN
TKBL_OPT_KOREAN_HANGUL_2_BULSIK0x0412KOR
TKBL_OPT_SIMPLIFIED_CHINESE_PINYIN0x0804CHS
TKBL_OPT_TRADITIONAL_CHINESE_PHONETIC0x0404CHT

 

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Ctffunc.h

IDL

Ctffunc.idl

See also

ITfFnGetPreferredTouchKeyboardLayout