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

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

  • Статья

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

Синтаксис

LONG ImmGetCompositionStringA(
                  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 удаляет сведения, когда приложение вызывает функцию ImmReleaseContext .

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

Примечание

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

Требования

Требование Значение
Минимальная версия клиента Windows XP [только классические приложения], установленная поддержка восточноазиатских языков.
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header imm.h (включая Immdev.h, Windows.h)
Библиотека Imm32.lib
DLL Imm32.dll

См. также раздел

ImmReleaseContext

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

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

WM_IME_COMPOSITION

WM_IME_STARTCOMPOSITION