Skip to content

Latest commit

 

History

History
169 lines (118 loc) · 5.65 KB

nf-textserv-itextservices-txsendmessage.md

File metadata and controls

169 lines (118 loc) · 5.65 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:textserv.ITextServices.TxSendMessage
ITextServices::TxSendMessage (textserv.h)
Used by the window host to forward messages sent from its window to the text services object.
ITextServices interface [Windows Controls]
TxSendMessage method
ITextServices.TxSendMessage
ITextServices::TxSendMessage
TxSendMessage
TxSendMessage method [Windows Controls]
TxSendMessage method [Windows Controls]
ITextServices interface
_win32_ITextServices_TxSendMessage
_win32_ITextServices_TxSendMessage_cpp
controls.ITextServices_TxSendMessage
controls._win32_ITextServices_TxSendMessage
textserv/ITextServices::TxSendMessage
controls\ITextServices_TxSendMessage.htm
Controls
VS|Controls|~\controls\richedit\windowlessricheditcontrols\windowlessricheditcontrolsreference\windowlessricheditcontrolinterfaces\txsendmessage.htm
12/05/2018
ITextServices interface [Windows Controls],TxSendMessage method, ITextServices.TxSendMessage, ITextServices::TxSendMessage, TxSendMessage, TxSendMessage method [Windows Controls], TxSendMessage method [Windows Controls],ITextServices interface, _win32_ITextServices_TxSendMessage, _win32_ITextServices_TxSendMessage_cpp, controls.ITextServices_TxSendMessage, controls._win32_ITextServices_TxSendMessage, textserv/ITextServices::TxSendMessage
textserv.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
Msftedit.dll
Windows
19H1
ITextServices::TxSendMessage
textserv/ITextServices::TxSendMessage
c++
APIRef
kbSyntax
COM
Msftedit.dll
ITextServices.TxSendMessage

ITextServices::TxSendMessage

-description

Used by the window host to forward messages sent from its window to the text services object.

-parameters

-param msg

Type: UINT

The message identifier.

-param wparam

Type: WPARAM

The WPARAM from the window's message.

-param lparam

Type: LPARAM

The LPARAM from the window's message.

-param plresult

Type: LRESULT*

The message's return LRESULT.

-returns

Type: HRESULT

If the method succeeds, the return value is S_OK.

If the method fails, the return value is one of the following HRESULT codes. For more information on COM error codes, see Error Handling in COM.

Return code Description
E_OUTOFMEMORY
Insufficient memory. NOERROR Message was processed, and some action was taken.
S_FALSE
Message was not processed. Typically indicates that the caller should process the message itself, potentially by calling DefWindowProc.
S_MSG_KEYIGNORED
Message processed, but no action was taken for the keystroke.

-remarks

Note that two return values are passed back from this function. The return value that should be passed back from a window procedure is plresult. However, in some cases, the returned LRESULT does not contain enough information. For example, to implement moving the cursor around controls, it's useful to know if a keystroke (such as right arrow) was processed but ignored (for example, the caret is already at the rightmost position in the text). In these cases, more information may be returned through the returned HRESULT.

WM_CHAR and WM_KEYDOWN should return the value S_MSG_KEYIGNORED when a key or character is recognized, but has no effect, given the current state. For example, S_MSG_KEYIGNORED should be returned in the following cases:

  • Any keystroke that tries to move the insertion point to or beyond the beginning or the end of the document; when it is already at the beginning or end of the document, respectively.
  • Any keystroke that tries to move the insertion point to or past the next line when it is already on the last line; or to or before the previous line when it is already on the first line.
  • Any insertion of the character from WM_CHAR that would move the insertion point past the maximum length of the control.

-see-also

Conceptual

DefWindowProc

ITextServices

Other Resources

WM_CHAR

WM_KEYDOWN

Windowless Rich Edit Controls