Функция ImmGetCompositionStringW (imm.h)

Статья
11/20/2024

Извлекает сведения о строке композиции.

Синтаксис

LONG ImmGetCompositionStringW(
                  HIMC   unnamedParam1,
                  DWORD  unnamedParam2,
  [out, optional] LPVOID lpBuf,
  [in]            DWORD  dwBufLen
);

Параметры

unnamedParam1

unnamedParam2

[out, optional] lpBuf

Указатель на буфер, в котором функция получает сведения о строке композиции.

[in] dwBufLen

Размер в байтах выходного буфера, даже если выходные данные являются строкой Юникода. Приложение задает этому параметру значение 0, если функция должна возвращать размер требуемого выходного буфера.

Возвращаемое значение

Возвращает количество байтов, скопированных в выходной буфер. Если dwBufLen имеет значение 0, функция возвращает размер буфера в байтах, необходимый для получения всех запрошенных сведений, за исключением конца символа NULL. Возвращаемое значение всегда равно размеру в байтах, даже если запрошенные данные являются строкой Юникода.

Эта функция возвращает один из следующих отрицательных кодов ошибок, если он не выполнен.

IMM_ERROR_NODATA. Данные композиции не готовы в контексте входных данных.
IMM_ERROR_GENERAL. Общая ошибка, обнаруженная IME.

Замечания

Приложение вызывает эту функцию в ответ на сообщение WM_IME_COMPOSITION или WM_IME_STARTCOMPOSITION. IMM удаляет сведения, когда приложение вызывает функцию ImmReleaseCon text.

Примечание Необходимо написать код для обработки полной ширины Hiragana и половины ширины Katakana, если приложение используется с панелью обратимого ввода (SIP).

Заметка

Заголовок imm.h определяет ImmGetCompositionString как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [только классические приложения], установленная поддержка языка Восточной Азии.
минимальный поддерживаемый сервер	Windows Server 2003 [только классические приложения]
целевая платформа	Виндоус
заголовка	imm.h (include Immdev.h, Windows.h)
библиотеки	Imm32.lib
DLL	Imm32.dll

См. также

ImmReleaseContext

диспетчера методов ввода

Функции диспетчера методов ввода

WM_IME_COMPOSITION

WM_IME_STARTCOMPOSITION

Поделиться через