#include <IUIDListData.h>
|
| enum | { kDefaultIID = IID_IUIDLISTDATA } |
| |
Interface for storing a list of UID values (UIDList). Use this when all the objects in the list are from the same database. Use IUIDRefListData if objects in the list can be from more than one database.
- See Also
- UIDList
- UIDRef
- IUIDRefListData
| virtual IDataBase* IUIDListData::GetDataBase | ( | | ) | |
| pure virtual |
Return the database that the items in the list are in.
- Returns
- IDataBase* - which database the UIDs are in
| virtual const UIDRef IUIDListData::GetItemRef | ( | int32 | index | ) | const |
| pure virtual |
Return the n'th item in the list.
- Parameters
| index | - which item in the list to return (0-based) |
- Returns
- UIDRef - the value of the item as an object reference. This can be instantiated.
| virtual const UIDList* IUIDListData::GetRef | ( | | ) | const |
| pure virtual |
Return a pointer to the list. The pointer is still owned by this object, so if you need to
make changes you should copy the list. The pointer is nil if the list has never been set. There is no need to delete it.
- Returns
- UIDList* - the list
| virtual void IUIDListData::Set | ( | UIDList * | array | ) | |
| pure virtual |
Set the value of the list. This object will acquire ownership of the array, and will delete it.
- Parameters
| array | - the new value of the list |