IPersistStorage::IsDirty

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method indicates whether the object has changed since it was last saved to its current storage.

Syntax

HRESULT IsDirty(void);

Parameters

None.

Return Value

The following table shows the return values for this method.

Remarks

This method checks whether an object has changed since it was last saved so you can save it before closing it. The dirty flag for an object is conditionally cleared in the IPersistStorage::Save method.

For example, you could optimize a File:Save operation by calling the IPersistStorage::IsDirty method for each object and then calling the IPersistStorage::Save method only for those objects that are dirty.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Notes to Callers

You should treat any error return codes as an indication that the object has changed. In other words, unless this method explicitly returns S_FALSE, you must assume that the object needs to be saved.

Notes to Implementers

A container with one or more contained objects must maintain an internal dirty flag that is set whenever any of its contained objects are dirty.

Requirements

See Also

Reference

IPersistStorage::Save