Download FDK Programmer`s Reference

Transcript
4
FDK Function Reference
F_ApiGetTextProps()
Arguments
docId
The ID of the document containing the text location.
textLocp
The text location of the character that you want to get text properties for. The
returned properties are the properties that apply to the character to the right of
the specified location. For information on specifying text locations, see
“Getting and setting the insertion point or text selection” on page 321 of the
FDK Programmer’s Guide.
Returns
The text property list (an F_PropValsT structure) for the text location.
If F_ApiGetTextProps() fails, the API sets the len field of the returned structure
to 0 and assigns one of the following values to FA_errno.
FA_errno value
Meaning
FE_BadDocId
Invalid document ID
FE_BadObjId
Invalid object ID
FE_NotTextObject
Object specified for the text location is not an object that contains
text
FE_OffsetNotFound
Offset specified for the text location couldn’t be found in the
specified paragraph or text line
FE_WrongProduct
Current FrameMaker product doesn’t support the operation
The returned F_PropValsT structure references memory that is allocated by the API.
Use F_ApiDeallocatePropVals() to free this memory when you are done with it.
266
FDK Programmer’s Reference