ITextStrings::EncodeFunction method (tom.h)

Encodes an object, given a set of argument strings.

Syntax

HRESULT EncodeFunction(
  [in] long        Type,
  [in] long        Align,
  [in] long        Char,
  [in] long        Char1,
  [in] long        Char2,
  [in] long        Count,
  [in] long        TeXStyle,
  [in] long        cCol,
  [in] ITextRange2 *pRange
);

Parameters

[in] Type

Type: long

The object type. See ITextRange2::GetInlineObject for a table of definitions.

[in] Align

Type: long

The object alignment. See ITextRange2::GetInlineObject for a table of definitions.

[in] Char

Type: long

The object character.

[in] Char1

Type: long

The object character.

[in] Char2

Type: long

The object character.

[in] Count

Type: long

The count of strings (arguments) to concatenate.

[in] TeXStyle

Type: long

The TeX style.

[in] cCol

Type: long

The count of columns (tomArray only).

[in] pRange

Type: ITextRange2*

The specifying range that points at the desired formatting.

Return value

Type: HRESULT

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

Remarks

See ITextRange2::GetInlineObject for a more detailed discussion of the arguments.

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

ITextStrings