ITextStrings::Append method

Appends a string to the string at the specified index in the collection.

Syntax


HRESULT Append(
  [in]  ITextRange2 *pRange,
  [in]  long iString
);

Parameters

pRange [in]

Type: ITextRange2*

The string to append.

iString [in]

Type: long

The string index.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return codeDescription
E_INVALIDARG

Invalid argument.

E_OUTOFMEMORY

Insufficient memory.

 

Remarks

The index is relative to the top of the collection, so if iString is equal to 0 the string is inserted at the top. If iString is equal to –1, it is inserted below the top string, and so on.

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft