Adobe 65030365 - FrameMaker - PC Manual page 443

ADOBE FRAMEMAKER SCRIPTING GUIDE
Function Summary
Parameters
Parameter name
saveAsName
saveParams
saveReturnParams
UpdateBook
Description
The method updates a book.
UpdateBook()
The method allows you to specify a script (property list) specifying how to update the book and how to deal with error
and warning conditions.
For example, you can specify whether to abort or to continue updating a book if it contains view-only documents.
Note: Always initialize the pointer to the property list that you specify for
call UpdateBook().
To get a property list to specify for the
the list from scratch.
The following are the properties that you can use in the property list:
Property
Constants.FS_AlertUserAboutFailure (2)
Constants.FS_AllowInconsistentNumProps (6)
Data Type Optional
string No
No
PropVals
No
PropVals
parameter, use
updateParamsp
Meaning
Alert user with warnings and messages if necessary. Set this parameter to True or False
as desired.
•
True - Notify user when unexpected conditions occur.
•
False - Do not notify user when unexpected conditions occur.
Allow the FrameMaker product to update numbering, text insets and other properties
of all the FrameMaker documents in the book, even if there are documents in the book
with numbering properties that do not match the properties specified in the book. The
permissible values are as follows:
•
Constants.FV_DoOK (1) - Update numbering even if there are inconsistent properties
in the book.
•
Constants.FV_DoCancel (0) - Cancel the update operation when FrameMaker
encounters a document with inconsistent numbering properties.
•
Constants.FV_DoShowDialog (4) - Show a dialog box and let the user decide.
Last updated 9/26/2011
Description
The path for saving the document or book.
A property list that tells FrameMaker how to save the file and
how to respond to errors and other conditions. Use
GetSaveDefaultParams() or AllocatePropVals() to create and
allocate memory for this property list. To use the default list,
specify null .
A property list that returns information about how the
FrameMaker product saved the file.
updateReturnParamspp
GetUpdateBookDefaultParams()
435
to null before you
or create