GetPageFilename

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

The GetPageFilename transaction returns the file name of the specified page.

Type XTYP_REQUEST

Syntax [GetPageFilename(docwinID, <pageID>)]

Parameter

Data type

Values

Meaning

docwinID

DWORD

0 | docwinID

active | specific

pageID

DWORD

0 | pageID

current | specific. Optional parameter.

Reply

Data type

Meaning

fileName

string

file name including path of the page file

Remarks

If the file format of the specified document is a valid page format (Spicer Multilayer Page or Spicer Document), its file name is returned (assuming that the name itself is valid). If not, the directory location of the page document is determined, and its disk file name is returned. If that cannot be found either, an error message is returned.

Release Information

Added in Release 3.70.

See also

Setting or requesting file names