ITextDocument2::GetCaretType method (tom.h)

Gets the caret type.

Syntax

HRESULT GetCaretType(
  [out, retval] long *pValue
);

Parameters

[out, retval] pValue

Type: long*

The caret type. It can be one of the following values:

tomKoreanBlockCaret

tomNormalCaret

tomNullCaret

Return value

Type: HRESULT

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Requirements

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

See also

ITextDocument2

ITextDocument2::SetCaretType