ImmGetCompositionFontA function (immdev.h)

Article
02/22/2024

Retrieves information about the logical font currently used to display characters in the composition window.

Syntax

BOOL ImmGetCompositionFontA(
        HIMC       unnamedParam1,
  [out] LPLOGFONTA lplf
);

Parameters

unnamedParam1

[out] lplf

Pointer to a LOGFONT structure in which this function retrieves the font information.

Return value

Returns a nonzero value if successful, or 0 otherwise.

Remarks

Note

The immdev.h header defines ImmGetCompositionFont 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	immdev.h (include Immdev.h, Windows.h)
Library	Imm32.lib
DLL	Imm32.dll