ITextStory::SetText method (tom.h)

Article
02/22/2024

Replaces the text in a story with the specified text.

Syntax

HRESULT SetText(
  [in] long Flags,
  [in] BSTR bstr
);

Parameters

[in] Flags

Type: long

Flags controlling how the text is inserted as defined in the following table:

tomCheckTextLimit

tomMathCFCheck

tomUnhide

tomUnicodeBiDi

tomUnlink

[in] bstr

Type: BSTR

The new text for this story. If this parameter is NULL, the text in the story is deleted.

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.
E_ACCESSDENIED	Write access is denied.
E_OUTOFMEMORY	Insufficient memory.

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

Share via