ESS_LOAD_BUFFER_T

Contains information about aggregate storage data load buffers. It is used by EssListExistingLoadBuffers.

typedef struct ESS_LOAD_BUFFER_T
{
   ESS_ULONG_T         ulBufferId;
   ESS_ULONG_T         ulDuplicateAggregationMethod;
   ESS_ULONG_T         ulOptionFlags;
   ESS_ULONG_T         ulSize;
   ESS_BOOL_T         bInternal;
   ESS_BOOL_T         bActive;
   ESS_BOOL_T         bReserved01;
   ESS_BOOL_T         bReserved02;
   ESS_ULONG_T         ulReserved01;
   ESS_ULONG_T         ulReserved02;
   ESS_ULONG_T         ulReserved03;
} ESS_LOAD_BUFFER_T;
Data TypeFieldDescription
ESS_ULONG_TulBufferIdID of a data load buffer (a number between 1 and 4294967296).
ESS_ULONG_TulDuplicateAggregationMethodOne of the following constants describing how to combine multiple values for the same cell within the buffer:
  • ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD: Add values when the buffer contains multiple values for the same cell.

  • ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL: Verify that multiple values for the same cells are identical, and ignore the duplicates if they are. Stop the data load with an error message if they differ.

  • ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST: Use the last value loaded into the buffer as the final value for the cell.

ESS_ULONG_TulOptionFlags

Either (or a combination) of the following load buffer options:

  • ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES

  • ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES

ESS_ULONG_TulSizeThe percentage of the aggregate storage cache that the data load buffer is allowed to use (a number between 1 and 100, inclusive)
ESS_BOOL_TbInternalESS_TRUE if the buffer was created by Essbase; ESS_FALSE for user-created buffers
ESS_BOOL_TbActiveESS_TRUE if the buffer is currently in use by a data load
ESS_BOOL_TbReserved01Not used
ESS_BOOL_TbReserved02Not used
ESS_ULONG_TulReserved01Not used
ESS_ULONG_TulReserved02Not used
ESS_ULONG_TulReserved03Not used