OSAPI  0.29
Open System API
osapi_common_list_S Struct Reference

#include <common_types_list.h>

Collaboration diagram for osapi_common_list_S:

Data Fields

t_size capacity
 The number of items that the list can accommodate.
 
t_size requiredCapacity
 The number of items would be required (in case the capacity is less what was required )
 
t_size itemSize
 Size, in bytes, of each item in memory. This is typically the sizeof of a given type.
 
t_size nitems
 Current capacity usage, i.e. how many items are in the list.
 
t_memory mem
 Allocated memory to store the array of items.
 

Detailed Description

Structure supporting a self describing list of items The reasoning behind this type is that many interface functions require too many parameters

  • Size of the allocated memory
  • Usage of the allocated memory It should be the same but a system is dynamic and between calls such as getNumberItems and getItems the number of items may have shrink or grow
  • The memory address of raw data
  • Also, ideally a parameter that specifies how big the list is currently

The documentation for this struct was generated from the following file: