List Routines

These functions maintains a linked list of items. A linked list is represented by its LIST structure. In the moment of adding an item in the list you can choose if the function will automatically allocate extra memory for you and copy data in it. If its the case, deallocation functions will automatically release this extra allocated memory.


List Routines

Routine Use
ListAddItem (v2*) Add an item to the list
ListCreate Create a new list
ListDestroy (v2*) Destroy a list releasing allocated memory
ListGetIndex Get the index of an item
ListGetIndexByHandle Get the index of an item through its handle
ListGetItemByHandle Get an item through its handle
ListGetItemByIndex Get an item through its index
ListGetItemByObject (v2*) Get an item through its object address
ListGetObjectByHandle Get the object address through the handle of the item
ListGetObjectByIndex Get the object address through the index of the item
ListGetRelativeItem Get an item through the relative position of another item
ListGetRelativePosition Get the relative position between two items
ListMakeFirst (v2) Moves an item to the top of the list
ListMakeLast (v2) Moves an item to the bottom of the list
ListRemoveItem Remove an item from the list releasing allocated memory
ListRemoveItemByHandle Remove an item from the list through its handle, releasing allocated memory
ListRemoveItemByIndex Remove an item from the list through its index, releasing allocated memory
ListRemoveItemByObject Remove an item from the list through its object address, releasing allocated memory
ListSort Sort the list
ListSwap (v2) Swap two items in the list

v2: new in version 2 
v2*: updated in version 2

See Also

List Structures