Edit

Share via

ITfUIElementMgr::BeginUIElement method (msctf.h)

  • Article

The ITfUIElementMgr::BeginUIElement method is called by a text service before showing UI. The value returned determines whether the UI for the text service should be shown or not.

Syntax

HRESULT BeginUIElement(
  [in]  ITfUIElement *pElement,
        BOOL         *pbShow,
  [out] DWORD        *pdwUIElementId
);

Parameters

[in] pElement

[in] A pointer to the ITfUIElement interface of the UIElement object.

pbShow

[in, out] If false is returned, the application may draw the UI by itself and a text service does not show its own UI for this UI element.

[out] pdwUIElementId

[out] A pointer to receive the ID of this UI element.

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.
E_UNEXPECTED
 Recursion call of ITfUIElementMgr interface happened.

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