Skip to content

Latest commit

 

History

History
144 lines (102 loc) · 4.83 KB

nf-tom-itextrange-movestartuntil.md

File metadata and controls

144 lines (102 loc) · 4.83 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:tom.ITextRange.MoveStartUntil
ITextRange::MoveStartUntil (tom.h)
Moves the start position of the range the position of the first character found that is in the set of characters specified by Cset, provided that the character is found within Count characters of the start position.
ITextRange interface [Windows Controls]
MoveStartUntil method
ITextRange.MoveStartUntil
ITextRange::MoveStartUntil
MoveStartUntil
MoveStartUntil method [Windows Controls]
MoveStartUntil method [Windows Controls]
ITextRange interface
_win32_ITextRange_MoveStartUntil
_win32_ITextRange_MoveStartUntil_cpp
controls.ITextRange_MoveStartUntil
controls._win32_ITextRange_MoveStartUntil
tom/ITextRange::MoveStartUntil
controls\ITextRange_MoveStartUntil.htm
Controls
VS|Controls|~\controls\richedit\textobjectmodel\textobjectmodelreference\textobjectmodelinterfaces\movestartuntil.htm
12/05/2018
ITextRange interface [Windows Controls],MoveStartUntil method, ITextRange.MoveStartUntil, ITextRange::MoveStartUntil, MoveStartUntil, MoveStartUntil method [Windows Controls], MoveStartUntil method [Windows Controls],ITextRange interface, _win32_ITextRange_MoveStartUntil, _win32_ITextRange_MoveStartUntil_cpp, controls.ITextRange_MoveStartUntil, controls._win32_ITextRange_MoveStartUntil, tom/ITextRange::MoveStartUntil
tom.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
Msftedit.dll
Windows
19H1
ITextRange::MoveStartUntil
tom/ITextRange::MoveStartUntil
c++
APIRef
kbSyntax
COM
Msftedit.dll
ITextRange.MoveStartUntil

ITextRange::MoveStartUntil

-description

Moves the start position of the range the position of the first character found that is in the set of characters specified by Cset, provided that the character is found within Count characters of the start position.

-parameters

-param Cset

Type: VARIANT*

The character set to use in the match. This could be an explicit string of characters or a character-set index. For more information, see Character Match Sets.

-param Count

Type: long

Maximum number of characters to move past. The default value is tomForward, which searches to the end of the story. If Count is greater than zero, the search is forward—toward the end of the story—and if Count is less than zero, search is backward—toward the beginning. If Count is zero, the start position is unchanged.

-param pDelta

Type: long*

The actual number of characters the start of the range is moved, plus 1 for a match if Count is greater than zero, and –1 for a match if Count is less than zero. The value can be null.

-returns

Type: HRESULT

The method returns an HRESULT value. If the method succeeds, it returns S_OK. If the method fails, it returns one of the following error codes. For more information about COM error codes, see Error Handling in COM.

Return code Description
E_INVALIDARG
Cset is not valid.
S_FALSE
Failure for some other reason.

-remarks

If no character from Cset is found within Count positions of the start position, the range is left unchanged.

If the new start follows the old end, the new end is set equal to the new start.

The motion described by ITextRange::MoveStartUntil is logical rather than geometric. That is, motion is toward the end or toward the start of a story. Depending on the language, moving to the end of the story could be moving left or moving right.

For more information, see ITextRange and ITextRange::Move.

-see-also

Conceptual

ITextRange

Move

MoveUntil

Reference

Text Object Model