ImmGetRegisterWordStyleW function (immdev.h)

Article
02/22/2024

Retrieves a list of the styles supported by the IME associated with the specified input locale.

Syntax

UINT ImmGetRegisterWordStyleW(
        HKL         unnamedParam1,
  [in]  UINT        nItem,
  [out] LPSTYLEBUFW lpStyleBuf
);

Parameters

unnamedParam1

[in] nItem

Maximum number of styles that the output buffer can hold. The application sets this parameter to 0 if the function is to count the number of styles available in the IME.

[out] lpStyleBuf

Pointer to a STYLEBUF structure in which the function retrieves the style information.

Return value

Returns the number of styles copied to the buffer. If the application sets the nItem parameter to 0, the return value is the number of styles available in the IME.

Remarks

Note

The immdev.h header defines ImmGetRegisterWordStyle 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