ImmSetCompositionFontW function (imm.h)

Sets the logical font to use to display characters in the composition window.

Syntax

BOOL ImmSetCompositionFontW(
       HIMC       unnamedParam1,
  [in] LPLOGFONTW lplf
);

Parameters

unnamedParam1

[in] lplf

Pointer to a LOGFONT structure containing the font information to set.

Return value

Returns a nonzero value if successful, or 0 otherwise.

Remarks

This function causes a IMN_SETCOMPOSITIONFONT command to be sent to an application. Even if the application never uses the composition window, it must set the appropriate font to ensure that characters are displayed properly. This is especially true for vertical writing.

Note

The imm.h header defines ImmSetCompositionFont as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only],East Asian language support installed.
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header imm.h (include Immdev.h, Windows.h)
Library Imm32.lib
DLL Imm32.dll

See also

IMN_SETCOMPOSITIONFONT

Input Method Manager

Input Method Manager Functions