Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfUIElementMgr::BeginUIElement method

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

pElement [in]

[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.

pdwUIElementId [out]

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

Return value

This method can return one of these values.

ValueDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

DLL

Msctf.dll

 

 

Show:
© 2017 Microsoft