The GetDocumentFilename transaction returns the file name of the specified document.
Type XTYP_REQUEST
Syntax [GetDocumentFilename(docwinID)]
|
Parameter |
Data type |
Values |
Meaning |
|
docwinID |
DWORD |
0 | docwinID |
active | specific |
|
Reply |
Data type |
Meaning |
|
fileName |
file name including path of the document |
Remarks
If the file format of the specified document is valid--if it is a Spicer Multipage, Spicer Document, or Spicer Multilayer Page--its file name is returned (assuming that the name itself is valid). If the document is of a different format, the directory location of the document is determined, and its disk file name is returned. If that cannot be found either, an error message is returned: "valid file name unavailable."
Release Information
Added in Release 3.70.
See also