IActiveIMMApp::GetConversionListA method

  • Article

Gets the list of characters or words from one character or word (ANSI implementation).

Syntax

HRESULT GetConversionListA(
  [in]  HKL           hKL,
  [in]  HIMC          hIMC,
  [in]  LPSTR         pSrc,
  [in]  UINT          uBufLen,
  [in]  UINT          uFlag,
  [out] CANDIDATELIST *pDst,
  [out] UINT          *puCopied
);

Parameters

  • hKL [in]
    A handle to the keyboard layout.

  • hIMC [in]
    A handle to the input context.

  • pSrc [in]
    The address of a string value that contains a null-terminated character string.

  • uBufLen [in]
    An unsigned integer value that contains the size of the destination buffer, in bytes.

  • uFlag [in]
    An unsigned integer value that contains action flags.

  • pDst [out]
    The address of the CANDIDATELIST structure that receives the conversion result.

  • puCopied [out]
    The address of an unsigned integer value that receives the number of bytes that are copied to the specified buffer. If uBufLen is zero, puCopied receives the number of bytes that are required to receive the list.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method maps to the ImmGetConversionList function that is documented in the Windows Software Development Kit (SDK).

Requirements

Minimum supported client

 Windows XP

Minimum supported server

 Windows 2000 Server

Product

 Internet Explorer 5.0

Header

 Dimm.h

IDL

 Dimm.idl

See also

IActiveIMMApp