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
The method can return one of the following 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 UIElementMgr interface happened.
|
Requirements
| Client | Requires Windows XP, Windows 2000 Professional, or Windows NT Workstation. |
|---|
| Redistributable | Requires TSF 1.0 on Windows NT 4.0, Windows 2000 Professional and Windows MeWindows 98. |
|---|
| Header | Declared in Msctf.idl and Msctf.h. |
|---|
| DLL | Requires Msctf.dll. |
|---|
See Also
ITfUIElementMgr
Send comments about this topic to Microsoft
Build date: 12/17/2008