Class DependentEnumProc
See Also: Class ReferenceTarget.
class DependentEnumProc
Description:
This class is a callback object for the ReferenceTarget::EnumDependents() method. The proc() method is called by the system.
Methods:
Prototype:
virtual int proc(ReferenceMaker *rmaker)=0;
Remarks:
Implemented by the Plug-In.
This is the method called by system from ReferenceTarget::EnumDependents().
Parameters:
ReferenceMaker *rmaker
A pointer to the reference maker
Return Value:
One of the following values:
DEP_ENUM_CONTINUE
This continues the enumeration.
DEP_ENUM_HALT
The stops the enumeration.
DEP_ENUM_SKIP
This option is available in release 3.0 and later only.
Reference Targets can have multiple Reference Makers (dependents). In certain instances when EnumDependents() is used to enumerate them you may not want to travel up all of the "branches". By returning DEP_ENUM_SKIP from this method you tell the enumerator to not enumerate the current Reference Maker's dependents but not to halt the eumeration completely.