Help Center

CTextRange2.GetInlineObjectmethod

Gets the properties of the inline object at the range active end.

Windowsmethoddocumented

Syntax

FUNCTION GetInlineObject (BYVAL pType AS LONG PTR, BYVAL pAlign AS LONG PTR, BYVAL pChar AS LONG PTR, BYVAL pChar1 AS LONG PTR, BYVAL pChar2 AS LONG PTR, BYVAL pCount AS LONG PTR, BYVAL pTeXStyle AS LONG PTR, BYVAL pcCol AS LONG PTR, BYVAL pLevel AS LONG PTR) AS HRESULT

Parameters

NameDescription
pTypeThe inline object type.
pAlignThe inline object alignment.
pCharThe inline object character.
pChar1The closing tomBrackets character.
pChar2The separator character for tomBracketsWithSep.
pCountThe inline object count of arguments.
pTeXStyleThe inline object TeX style.
pcColThe inline object count of columns (tomMatrix only).
pLevelThe inline object 0-based nesting level.

Return value

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

Description

Gets the properties of the inline object at the range active end.

See full MSDN documentation: ITextRange2::GetInlineObject method

Remarks

Unicode Technical Note 28 describes the alignment and character values in detail when the active end character is an inline object start delimiter.

When that character is not a start delimiter, the character and column parameters are set to 0, the count is set to the 0-based argument index, and the other parameters are set according to the active-end character properties of the innermost inline object argument.

Reference

  • Defined in AfxNova/CTextRange2.inc:998
  • Documented in Windows/WIndows Controls/RichEdit/CTextRange2 Class.md
  • Topic: CTextRange2 Class