EncodeFunction method

ITextStrings::EncodeFunction method

Encodes an object, given a set of argument strings.

Syntax


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

Parameters

Type [in]

Type: long

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

Align [in]

Type: long

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

Char [in]

Type: long

The object character.

Char1 [in]

Type: long

The object character.

Char2 [in]

Type: long

The object character.

Count [in]

Type: long

The count of strings (arguments) to concatenate.

TeXStyle [in]

Type: long

The TeX style.

cCol [in]

Type: long

The count of columns (tomArray only).

pRange [in]

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

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

ITextStrings

 

 

Show:
© 2016 Microsoft