Edit

ITextSelection::GetFlags method (tom.h)

  • Article

Gets the text selection flags.

Syntax

HRESULT GetFlags(
  long *pFlags
);

Parameters

pFlags

Type: long*

Any combination of the following selection flags.

Selection Flag Value Meaning
tomSelStartActive 1 Start end is active.
tomSelAtEOL 2 For 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.
tomSelOvertype 4 Insert/Overtype mode is set to overtype.
tomSelActive 8 Selection is active.
tomSelReplace 16 Typing 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

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

Conceptual

ITextRange

ITextSelection

Reference

SetFlags

Text Object Model