SavePage

image\bltlrgss.gif Editions  image\bltlrgss.gif Related Transactions  image\bltlrgss.gif Example

The SavePage transaction saves a page in the specified format. This transaction is normally used to save a multilayer page displayed alone in a document window, or a multilayer page within a Spicer Multipage (.das). You can optionally specify a new file name and output file format, and choose whether to prompt the user about a conflict between the new file name and an existing one.

Type XTYP_EXECUTE

Syntax [SavePage(docwinID, saveAs, "fileName", "pageLabel", docFormat, checkExistence, <pageID>)]

Parameter

Data type

Values

Meaning

docwinID

DWORD

0 | docwinID

active | specific

saveAs

BOOL

0 | 1

existing | fileName

fileName

string

file name including path to save the page under. See Remarks.

pageLabel

string

label, maximum 80 characters

docFormat

WORD

0

Spicer Multilayer Page (.clf)

 

 

1

Spicer Document (.smf)

checkExistence

BOOL

0 | 1

do not check | check. See Remarks.

pageID

DWORD

0 | pageID

current | specific. Optional parameter.

Remarks

If the page is contained within a Spicer Multipage document, its location must usually be the same as the document's.

If the checkExistence parameter is set to 1 and the file exists, Imagenation will prompt the user before overwriting.

Release Information

Added in Release 3.70.

See also

Saving documents