SaveEnumProc Class Reference

Search for all occurrences

---

Detailed Description

A callback class for saving dependents.

Instances of this class are passed to ReferenceMaker::SaveEum. Typically, terminate is called passing in the ReferenceMaker instance, and if terminate returns FALSE SaveEnum is called on ReferenceMaker's custom attribute container, its direct references, and its indirect references. Finally, proc is called passing in the ReferenceMaker instance. If terminate returns TRUE, SaveEnum typically immediately returns.

#include <ref.h>

Inheritance diagram for SaveEnumProc:

List of all members.

Public Member Functions
virtual void	proc (ReferenceMaker *rmaker)=0
	This is the method allows processing the passed ReferenceMaker.
virtual int	terminate (ReferenceMaker *rmaker)=0
	This is the method specifies whether to continue processing the passed ReferenceMaker.

---

Member Function Documentation

virtual void proc

(

ReferenceMaker *

rmaker

)

[pure virtual]

Search for all occurrences

This is the method allows processing the passed ReferenceMaker.

Any processing needing to be performed on the passed RefenceMaker after enumerating the references held by the ReferenceMaker would be done in this method.

Parameters:

rmaker

- A pointer to the reference maker

Implemented in ReferenceSaveManager::PreSave, and ReferenceSaveManager::PostSave.

virtual int terminate

(

ReferenceMaker *

rmaker

)

[pure virtual]

Search for all occurrences

This is the method specifies whether to continue processing the passed ReferenceMaker.

This method specifies whether to continue processing the passed ReferenceMaker. Typically the method would check to see if the ReferenceMaker has already been processed and return TRUE if it has. Any processing needing to be performed before enumerating the references held by the ReferenceMaker would be done in this method.

Parameters:

rmaker

- A pointer to the reference maker

Returns:

FALSE if to continue enumerating the references held by the ReferenceMaker and call proc on the ReferenceMaker, TRUE to terminate processing of the ReferenceMaker.

Implemented in ReferenceSaveManager::PreSave, and ReferenceSaveManager::PostSave.