ITextSelection::GetFlags method

Gets the text selection flags.

Syntax


HRESULT GetFlags(
   long *pFlags
);

Parameters

pFlags

Type: long*

Any combination of the following selection flags.

Selection FlagValueMeaning
tomSelStartActive1Start end is active.
tomSelAtEOL2For degenerate selections, the ambiguous character position corresponding to both the beginning of a line and the end of the preceding line should have the caret displayed at the end of the preceding line.
tomSelOvertype4Insert/Overtype mode is set to overtype.
tomSelActive8Selection is active.
tomSelReplace16Typing and pasting replaces selection.

 

Each of the table values is binary. Thus, if any value is not set, the text selection has the opposite property.

Return value

Type: HRESULT

The method returns an HRESULT value. If the method succeeds, it returns S_OK. If pFlags is null, the method fails and it returns E_INVALIDARG.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextRange
ITextSelection
SetFlags
Conceptual
Text Object Model

 

 

Show: