Edit

Share via

ITextStrings::Remove method (tom.h)

  • Article

Removes a string from a string collection, starting at an index.

Syntax

HRESULT Remove(
  [in] long iString,
  [in] long cString
);

Parameters

[in] iString

Type: long

The string index.

[in] cString

Type: long

The count of strings to remove.

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 code Description
E_INVALIDARG
 Invalid argument.

Remarks

The index is relative to the top of the collection, so iString = 0 removes the top string (cString must be 1), iString = –1 removes the one below the top string (and the top string if cString = 2), and so on.

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