The GetPageDirtyStatus transaction returns the value of the dirty status flag for the specified page. This is generally done to determine whether a save or check in is required.
Type XTYP_REQUEST
Syntax [GetPageDirtyStatus(docwinID, checkLayers, <pageID>)]
|
Parameter |
Data type |
Values |
Meaning |
|
docwinID |
DWORD |
0 | docwinID |
active | specific |
|
checkLayers |
BOOL |
0 |
do not check if the layers on the page are dirty |
|
|
|
1 |
check if the layers on the page are dirty |
|
pageID |
DWORD |
0 | pageID |
current | specific. Optional parameter. |
|
Reply |
Data type |
Values |
Meaning |
|
dirtyStatus |
WORD |
1 |
clean |
|
|
|
2 |
modified |
|
|
|
8 |
new |
|
|
|
16 (can be ORed) |
modified since load (has been saved locally, but not to the database) |
Release Information
Added in Release 3.70.
See also