Adobe 65030365 - FrameMaker - PC Manual page 485

ADOBE FRAMEMAKER SCRIPTING GUIDE
Function Summary
On failure, the method sets the
values to :
FA_errno
Error
Constants.FE_BadDocId (-2)
Constants.FE_BadObjId (-3)
Constants.FE_NotTextObject (-41)
Constants.FE_BadRange (-36)
Constants.FE_OffsetNotFound (-21)
Note: The returned TextItems structure references memory that is allocated by the method. Use the
DeallocateTextItems() method to free this memory when you are done with using it.
Returns
TextItems
Syntax
GetTextForRange2(tr, flags, flags2)
Parameters
Parameter name
tr
flags
flags2
GetTextProps
Description
Gets the text properties (such as the format tag, font family and size, and conditions) for a location in text.
As the text properties can be different for each character, you can only get the text properties for an individual location
in the text.
On success, the method returns a
On failure, the method sets the
values to :
FA_errno
Error
Constants.FE_BadDocId (-2)
field of the returned
len TextItems
Reason
Invalid document.
Invalid Object
Object specified for the text range is not an object that contains text.
Specified text range is invalid.
Offset specified for the text location could not be found in the specified paragraph or text line.
Data Type Optional
No
TextRange
int No
int No
structure with the text property list for the specified location.
PropVals
field of the returned
len PropVals
Reason
Invalid document.
Last updated 9/26/2011
structure to 0, and returns one of the following
Description
The text range containing the text you want to get.
Bit flags for the base set text item types that of text items to
retrieve.
Bit flags for the extended set of text item types that specify the
type of text items to retrieve. To get specific types of text items
from the extended set, OR the constants that represent them
(for example, use a bitwise OR to combine FTI2_RubiTextBegin
and FTI2_RubiTextEnd) into flags2.
To get all types of the extended set of text items, specify -1.
structure to 0, and returns one of the following
477