IPersistStorage::IsDirty method

Determines whether an object has changed since it was last saved to its current storage.

Syntax


HRESULT IsDirty();

Parameters

This method has no parameters.

Return value

This method returns S_OK to indicate that the object has changed. Otherwise, it returns S_FALSE.

Remarks

Use this method to determine whether an object should be saved 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.

Notes to Callers

You should treat any error return codes as an indication that the object has changed. Unless this method explicitly returns S_FALSE, assume that the object must be saved.

Notes to Implementers

An object with no contained objects simply checks its dirty flag to return the appropriate result.

A container with one or more contained objects must maintain an internal dirty flag that is set when any of its contained objects has changed since it was last saved.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

ObjIdl.h

IDL

ObjIdl.idl

IID

IID_IPersistStorage is defined as 0000010a-0000-0000-C000-000000000046

See also

IPersistStorage

 

 

Show: