Adobe 65030365 - FrameMaker - PC Manual page 689

ADOBE FRAMEMAKER SCRIPTING GUIDE
Function Summary
Open
Description
Opens a document or book. It can also create a new document.
allows you to specify a property list telling FrameMaker how to open or create the file and how to deal with
Open()
error and warning conditions.
For example, you can specify whether to abort or to continue opening a document if it contains fonts that are not
available. If the file is already open and invisible, it will make the file visible.
To get a property list to specify for the
scratch.
To create a new document with
to .
True
Note: When creating a new document (
(Constants.
FS_ShowBrowser (1)
box, does not create a document. Intead, it returns 0 and sets FA_errno to either
Open()
Constants.FE_WantsPortrait (-48)
, respectively. It is up to your client to create a portrait, custom, or landscape document.
(-47)
Note: For more information on creating custom documents, see "CustomDoc" on page 652.
The method returns the document or book if it opens it successfully, or 0 if an error occurs.
The property list to which
openReturnParams
Property
Constants.FS_OpenedFileName (1)
Constants.FS_OpenNativeError (2)
Constants.FS_OpenStatus (3)
Both the
Constants.FS_OpenNativeError(2)
to . The following table lists the possible status flags and the
Open()
Constants.FS_OpenNativeError(2)
parameter, use
openParams
, set the
Open() Constants.FS_NewDoc(29)
Constants.FS_NewDoc (29)
is ) and if the user clicks etiher Portrait, Custom, or Landscape in the New dialog
True
,
Constants.FE_WantsCustom (-46)
is set has the properties shown in the following table:
Meaning and possible values
A string that specifies the opened file's pathname. If you scripted
Constants.FS_ShowBrowser (1)
the pathname, this pathname can be different from the one you specified in the
Open script.
The error condition; normally the same value as
successfully, it is set to
A bit field indicating what happened when the file was opened.
property and the
values associated with them.
Last updated 9/26/2011
GetOpenDefaultParams()
property in the
openParams
is ) and you display the New dialog box
True
, or
Constants.FE_WantsLandscape
, or the file was filtered, or you did not specify
FA_errno
FE_Success .
global variable indicate the result of a call
FA_errno
and
FA_errno
681
or create the list from
property list
. If the file is opened