Editions
Related Transactions
Example
The GetDocumentState transaction returns the value of the dirty status flag for the specified document, page, or layer. This is normally used to determine whether the document should be saved or checked in.
Type XTYP_REQUEST
Syntax [GetDocumentState(docwinID, <pageID>, <layerID>)]
|
Parameter |
Data type |
Values |
Meaning |
|
docwinID |
DWORD |
0 | docwinID |
active | specific |
|
pageID |
DWORD |
0 | pageID |
current | specific. Optional parameter. |
|
layerID |
DWORD |
identifier of the layer to query. Optional parameter. | |
|
Reply |
Data type |
Values |
Meaning |
|
objectState |
WORD |
1 |
clean |
|
|
|
2 |
modified |
|
|
|
4 |
deleted |
|
|
|
8 |
new |
|
|
|
16 |
modified since load (saved locally only, but not saved to the database) |
|
|
|
32 |
loaded |
|
|
|
128 |
read-only |
|
|
|
(can be ORed) |
|
Release Information
Added in Release 3.70.
See also