IActiveIMMIME::GetCandidateListA method

Gets a specified candidate list and copies the list to the specified buffer. (ANSI implementation).

Syntax

HRESULT GetCandidateListA(
  [in]  HIMC          hIMC,
  [in]  DWORD         dwIndex,
  [in]  UINT          uBufLen,
  [out] CANDIDATELIST *pCandList,
  [out] UINT          *puCopied
);

Parameters

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

• dwIndex [in]
  An unsigned long integer value that contains the zero-based index of the candidate list.

• uBufLen [in]
  An unsigned integer value that contains the size of the buffer, in bytes. If this is zero or if the buffer is insufficient to receive the candidate list, the method returns the size, in bytes, that is required to receive the complete candidate list to the variable that is specified by puCopied.

• pCandList [out]
  The address of the CANDIDATELIST structure that receives the candidate list.

• puCopied [out]
  The address of an unsigned integer variable that receives the number of bytes that are copied to the specified buffer, if the buffer is sufficient. Otherwise, it receives the size, in bytes, that is required to receive the complete candidate list.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

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

Requirements

See also

IActiveIMMIME

GetCandidateListW