EssListExistingLoadBuffers

Returns the list of structures that describe existing data load buffers for an aggregate storage database.

This function returns the count of existing buffers and an array of descriptor structures. The memory for the array must be freed using EssFree.

Syntax

ESS_FUNC_M EssListExistingLoadBuffers (hCtx, AppName, DbName, pCount, paLoadBuffers);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle
AppName	ESS_STR_T	Use NULL. Function always applies to the currently selected database.
DbName	ESS_STR_T	Use NULL. Function always applies to the currently selected database.
pCount	ESS_PULONG_T	Address of variable to receive count of load buffers
paLoadBuffers	ESS_LOAD_BUFFER_T**	Pointer to load buffer information structure

Return Value

Returns zero if successful; otherwise, returns an error code.

Example

void TestListExistingLoadBuffers(ESS_HCTX_T hCtx, ESS_STR_T AppName, ESS_STR_T DbName)
{
        ESS_STS_T       sts = ESS_STS_NOERR;
        ESS_LOAD_BUFFER_T *LoadBuffers;
        ESS_ULONG_T i;
        ESS_ULONG_T     Count;

        /* EssListExistingLoadBuffers */
        sts = EssListExistingLoadBuffers(hCtx, AppName, DbName, &Count, &LoadBuffers);
        printf("EssListExistingLoadBuffers sts: %ld\n",sts);
        printf("\tNumber of buffers: %d", Count);
        if(Count > 0)
        {
                for(i = 0; i < Count; i++)
                {
                                printf("\n\tBuffer Id: %d", LoadBuffers[i].ulBufferId);
                                printf("\n\tDuplicate Agg Method: %d", LoadBuffers[i].ulDuplicateAggregationMethod);
                                printf("\n\tOption Flags: %d", LoadBuffers[i].ulOptionFlags);
                                printf("\n\tSize (1-100): %d", LoadBuffers[i].ulSize);
                                printf("\n\tInternal: %d", LoadBuffers[i].bInternal);
                                printf("\n\tActive: %d", LoadBuffers[i].bActive);
                                printf("\n");
                }
        }
}