
571
ADOBE FRAMEMAKER SCRIPTING GUIDE
Function Summary
Last updated 9/26/2011
GetMetricByName
Description
Queries a metric facet.
GetMetricByName()
uses a transaction model to query facets. After you have finished a series of queries, you must
commit the transaction by calling
GetIntByName()
to query a facet named
" "
.
If
GetMetricByName()
returns 0, it may not indicate an error, because some facet values can be 0. To determine if a
returned 0 is a property value or an error, check
FA_errno
.
Returns the specified facet value, on success.
On failure, the method returns one of the following values to
FA_errno
:
Returns
int
Syntax
GetMetricByName(propName)
Parameters
GetUBytesByName
Description
Queries an unsigned bytes inset facet. The standard facets, EPSI and FrameImage, are examples of unsigned bytes
facets.
If a facet contains a large amount of data,
GetUBytesByName()
only gets a portion of the data each time you call it.
To query a facet that contains a large amount of data, call
GetUBytesByName()
repeatedly until you have retrieved all
the data (that is, until
UBytes.len
is 0).
GetUBytesByName()
uses a transaction model to query facets. After you have finished a series of queries, you must
commit the transaction by calling
GetIntByName()
to query a facet named
" "
.
On success, the method returns a
UBytes
object containing a portion of the facet’s data.
On failure, the method returns one of the following values to
FA_errno
:
Error
Reason
Constants.FE_BadDocId (-2)
Invalid document.
Constants.FE_BadObjId (-3)
Invalid object.
Constants.FE_BadPropNum (-4)
Specified property name is invalid.
Constants.FE_BadPropType (-5)
Incorrect property type.
Constants.FE_WrongProduct (-60)
Current FrameMaker does not support this operation.
Parameter name
Data Type
Optional
Description
propName
string
No
The name of the facet to query.
Содержание 65030365 - FrameMaker - PC
Страница 1: ...Scripting Guide ADOBE FRAMEMAKER 10...