Top > Visual Basic Main API > Visual Basic Main API Declarations > ESB_INIT_T

ESB_INIT_T

This structure is passed to the VB API initialization function EsbInit() 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, the API defaults are used. The fields are:

Type ESB_INIT_T

   Version              As Long                  
   MaxHandles           As Integer               
   LocalPath            As String * ESB_PATHLEN  
   MessageFile          As String * ESB_PATHLEN  
   HelpFile             As String * ESB_PATHLEN  
   ClientError          As Integer            
   ErrorStack           As Integer   
   vbCallbackFuncAddress   As Long         
End Type

VB Data Type	Field	Description
As Long	Version	Version of Essbase API used to compile the application. Used for backward compatibility.
As Integer	MaxHandles	The maximum number of simultaneous context handles required by the application (between 1 and 10)
As String * ESB_PATHLEN	LocalPath	The default local path name to use for file and object operations on the client
As String * ESB_PATHLEN	MessageFile	The qualified path name of the message database file, ESSBASE.MDB
As String * ESB_PATHLEN	HelpFile	Fully-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.
As String * 1	ClientError	ESB_FALSE to use a default error handler, ESB_TRUE to use EsbGetMessage to retrieve messages
As Integer	ErrorStack	A size of the message stack used by EsbGetMessage, default is 100
As Long	vbCallbackFuncAddress	AddressOf custom Visual Basic callback function. For more information, see Visual Basic API Message Handling.