Edit

ITfCandidateListUIElement::GetUpdatedFlags method (msctf.h)

  • Article

The ITfCandidateListUIElement::GetUpdatedFlags method returns the flag that tells which part of this element was updated.

Syntax

HRESULT GetUpdatedFlags(
  [out] DWORD *pdwFlags
);

Parameters

[out] pdwFlags

[out] a pointer to receive the flags that is a combination of the following bits:

Value Meaning
TF_CLUIE_DOCUMENTMGR
 The target document manager was changed.
TF_CLUIE_COUNT
 The count of the candidate string was changed.
TF_CLUIE_SELECTION
 The selection of the candidate was changed.
TF_CLUIE_STRING
 Some strings in the list were changed.
TF_CLUIE_PAGEINDEX
 The current page index or some page index was changed.
TF_CLUIE_CURRENTPAGE
 The page was changed.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
E_FAIL
 An unspecified error occurred.
E_INVALIDARG
 One or more parameters are invalid.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header msctf.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional