ESS_INIT_T

This structure is passed to the API initialization function EssInit() and contains fields that let API developers customize their usage of the API. If any of the fields of the structure are set to zero (or NULL for pointers), the API defaults are used. (See Using Memory in C Programs for more information.).

typedef struct ESS_INIT_T
{
   ESS_ULONG_T  Version;        
   ESS_PVOID_T  UserContext;    
   ESS_USHORT_T MaxHandles;     
   ESS_SIZE_T   MaxBuffer;      
   ESS_STR_T    LocalPath;      
   ESS_STR_T    MessageFile;    
   ESS_PFUNC_T  AllocFunc;      
   ESS_PFUNC_T  ReallocFunc;    
   ESS_PFUNC_T  FreeFunc;       
   ESS_PFUNC_T  MessageFunc;    
   ESS_STR_T    HelpFile;       
   ESS_ULONG_T  Ess_System;     
} ESS_INIT_T, *ESS_PINIT_T;
Data TypeFieldDescription
ESS_ULONG_TVersionVersion of Essbase API used to compile the application. Should be set to ESS_API_VERSION. Used for backward compatibility.
ESS_PVOID_TUserContextAn optional pointer to a user-defined message context (passed as argument to a user-defined MessageFunction)
ESS_USHORT_TMaxHandlesThe maximum number of simultaneous context handles required by the API program (between 1 and 255). The default is 255. Reducing this number may decrease the amount of client memory used within the API for your program.
ESS_SIZE_TMaxBufferThe maximum size buffer that can be allocated in the client program (typically 64 Kbytes). The default is 64 Kbytes.
ESS_STR_TLocalPathThe default local path name to use for file and object operations on the client. If this is not set, Essbase uses the ARBORPATH environment variable by default, and appends
\CLIENT
to the directory name passed in. If ARBORPATH is not defined, Essbase uses
\ARBOR32\CLIENT
.
ESS_STR_TMessageFileQualified path name of the Essbase message database file,
ESSBASE.MDB
. If this is not set, Essbase first tries to use the fully qualified path in the ARBORMSGPATH environment variable, otherwise, it uses
(ARBORPATH)\BIN\ESSBASE.MDB
. If ARBORPATH is not defined, an error is returned at run time.
ESS_PFUNC_TAllocFuncPointer to the user-defined memory allocation function. All platforms: memory allocation functions use the malloc() function.
ESS_PFUNC_TReallocFuncPointer to the user-defined memory reallocation function. All platforms: memory allocation functions use the realloc() function.
ESS_PFUNC_TFreeFuncA pointer to the user-defined memory free function. All platforms: memory allocation functions use the free() function.
ESS_PFUNC_TMessageFuncA pointer to the user-defined message callback function
ESS_STR_THelpFileFully-qualified path name of the user-defined application help file, used for help for the AutoLogin dialog box. The login help context must be defined in the help file. See Integrating Essbase with Your Product. Default:
$(ARBORPATH)\BIN\ESSAPIW.HLP
. If ARBORPATH is not defined, the help file name is set to null.
ESS_ULONG_TEss_SystemReserved for internal use. Set to NULL