OpenDocwin

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

The OpenDocwin transaction opens the specified document into a new window.

Type XTYP_REQUEST or XTYP_EXECUTE

Syntax [OpenDocwin(location, fileType, "fileName", "label", permissions, wOtherInfo, lOtherInfo)]

Parameter

Data type

Values

Meaning

location

WORD

0

file on disk

fileType

WORD

0

document type--ignored

fileName

string

file name including path of the document to open

label

string

label, maximum 80 characters. See Remarks.

permissions

WORD

0

placeholder

wOtherInfo

WORD

0

placeholder

lOtherInfo

WORD

0

placeholder

Reply

Data type

Values

Meaning

count

WORD

0

1 | 2 | 3 | ...

fail

number of documents opened. See Remarks.

docwinIDs...

DWORD

docwinID1, docwinID2, ...

identifier of the new document windows

Remarks

For the fourth parameter, specify the label that you want to be assigned to the root document. It does not have to be the label currently assigned to the file.

Replies are only returned when this transaction is called as an XTYP_REQUEST. The count will be 1 unless a Spicer Set (*.ls) containing more than one document is opened. A maximum of 100 windows can be opened at once.

Release information

Added in Release 3.40.

See also

Opening documents: basic

Defining window titles