dirty Parameter

Gives the setting of the dirty flag.

Scope: Document

Syntax

query dirty 

Options

None.

Description

The dirty flag is set on if there is an uncompleted change in the document.

A change to a document is complete when an undoable unit is closed, either explicitly by use of the check command, or automatically if the autocheck parameter has a value of on.

To find out if a file has unsaved changes, you must query both the changes and dirty parameters.

Example

To get the setting of the dirty flag, type:

query dirty 

API Return Codes

None.


changes Parameter
check Command