Constant Definitions

The following constants are defined in the Essbase Visual Basic global text file ESB32.BAS, and in the C language header file ESBAPI.H

Maximum String Lengths
Information Flag Constants
Size Flag Constants
Dimension Tag Constants

Maximum String Lengths

The following constants define the maximum lengths of various string types in the Essbase VB API and must be used for variable declarations in a VB application:

ConstantDefinition
ESB_USERNAMELENMaximum length of a user or group name
ESB_PASSWORDLENMaximum length of a user password
ESB_SVRNAMELENMaximum length of a server name
ESB_APPNAMELENMaximum length of an application name
ESB_DBNAMELENMaximum length of a database name
ESB_OBJNAMELENMaximum length of an object name
ESB_MBRNAMELENMaximum length of a member name
ESB_FTRNAMELENMaximum length of a filter name
ESB_ALIASNAMELENMaximum length of an alias table name
ESB_PATHLENMaximum length of a file path name
ESB_LINELENMaximum length of a line in a report
ESB_DESCLENMaximum length of application or database description

Information Flag Constants

The following constants define the available information flags used in the DbReqFlags (Data Load) field in the ESB_DBREQINFO_T structure.

ConstantDefinition
ESB_DBREQFLAG_CALCDEFDefault flag for DbReqFlags field. Used the default calc script. Value: 1.
ESB_DBREQFLAG_CALCDSCRCustom calc script flag for DbReqFlags field. Used a custom calc script. Value: 2.

Size Flag Constants

The following constants define the maximum and minimum size for the MaxMemIndex and IndexPageSize fields in the ESB_DBSTATE_T structure.

ConstantDefinition
ESB_INDEXCACHEMIN_SIZEMinimum index cache size for the MaxMemIndex field of the ESB_DBSTATE_T structure. Value: 1048576. No maximum value is defined.
ESB_INDEXPAGEMAX_SIZEMaximum index page size for the IndexPageSize field of the ESB_DBSTATE_T structure. Value: 8192
ESB_INDEXPAGEMIN_SIZEMinimum index page size for the IndexPageSizeMin field of the ESB_DBSTATE_T structure. Value: 1024

Dimension Tag Constants

The following constants define the available information flags used in the DimTag field in the ESB_DIMENSIONINFO_T structure.

ConstantDefinition
ESB_TTYPE_NONENo dimension type. Value for DimTag field of ESB_DIMENSIONINFO_T.
ESB_TTYPE_CATEGORYAccounts: Currency ACCOUNTS tag. Value for DimTag type of ESB_DIMENSIONINFO_T.
ESB_TTYPE_CNAMECountry: Currency COUNTRY tag. Value for DimTag field of ESB_DIMENSIONINFO_T.
ESB_TTYPE_CTIMETime: Currency TIME tag. Value for DimTag field of ESB_DIMENSIONINFO_T.
ESB_TTYPE_TYPEType: Currency TYPE tag. Value for DimTag field of ESB_DIMENSIONINFO_T.
ESB_TTYPE_PARTITIONCurrency PARTITION tag. Value of DimTag field of ESB_DIMENSIONINFO_T.