Store Entity

group StoreEntity

The store provides a flat file system on modules that have storage capacity. Files are referred to as slots and they have simple zero-based numbers for access. Store slots can be used for generalized storage and commonly contain compiled reflex code (files ending in .map) or templates used by the system. Slots simply contain bytes with no expected organization but the code or use of the slot may impose a structure. Stores have fixed indices’s based on type. Not every module contains a store of each type. Consult the module datasheet for details on which specific stores are implemented, if any, and the capacities of implemented stores.

void store_getSlotState(unsigned int *id, struct Result *result, int storeType, int slot)

Get slot state.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR and the slot state or a non zero Error code.

  • storeType: The index of the Store.

  • slot: The slot number

void store_slotEnable(unsigned int *id, struct Result *result, int storeType, int slot)

Enable slot.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR or a non zero Error code.

  • storeType: The index of the Store.

  • slot: The slot number

void store_slotDisable(unsigned int *id, struct Result *result, int storeType, int slot)

Disables slot.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR or a non zero Error code.

  • storeType: The index of the Store.

  • slot: The slot number

void store_loadSlot(unsigned int *id, struct Result *result, int storeType, int slot, unsigned char *pData, int length)

Load the slot.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR or a non zero Error code.

  • storeType: The index of the Store.

  • slot: The slot number

  • pData: The data to be loaded (pointer to the first index).

  • length: The length of the data to be loaded.

void store_unloadSlot(unsigned int *id, struct Result *result, int storeType, int slot, unsigned char *pData, int requestLength)

Unload the slot data.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR or a non zero Error code.

  • storeType: The index of the Store.

  • slot: The slot number

  • pData: Where the data will be placed (pointer to the first index)

  • requestLength: The length of the data to be unloaded

void store_getSlotCapacity(unsigned int *id, struct Result *result, int storeType, int slot)

Get the slot capacity.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR and the capacity of the defined slot or a non zero Error code.

  • storeType: The index of the Store.

  • slot: The slot number

void store_getSlotSize(unsigned int *id, struct Result *result, int storeType, int slot)

Get the slot size.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR and the size of the defined slot or a non zero Error code.

  • storeType: The index of the Store.

  • slot: The slot number