Class RefList
See Also: Class RefListItem.
class RefList
Description:
The method GetRefList() returns a list of references to a reference target. This class is linked list of references. All methods of this class are implemented by the system.
Data Members:
public:
RefListItem* first;
Methods:
Prototype:
RefList()
Remarks:
Constructor. The list is set to NULL.
Prototype:
RefListItem* FirstItem()
Remarks:
Returns the first item in the list.
Prototype:
RefResult DeleteItem(RefMakerHandle hmaker, int eval);
Remarks:
Deletes the specified item from the list.
Parameters:
RefMakerHandle hmaker
The item to delete.
int eval
If nonzero then when inside of NotifyDependents(), just set maker to NULL.
Return Value:
If the item was deleted REF_SUCCEED is returned; otherwise REF_INVALID is returned.
Prototype:
RefResult AddItem(RefMakerHandle hmaker);
Remarks:
Adds the specified item to the list.
Parameters:
RefMakerHandle hmaker
The item to add.
Return Value:
Returns REF_SUCCEED.
Prototype:
void Cleanup();
Remarks:
This method removes null entries from the list.