C Grid API Constants

The following constants are defined in the Essbase Grid API.

Returned on successful API call.

ConstantDefinition
ESSG_STS_NOERR0

Defines the version of the EGAPI API. Changes each time the API is modified.

ConstantDefinition
ESSG_VERSION0x00040000

Define the maximum number of rows and columns supported

ConstantDefinition
WINDOWS 
ESSG_MAXROWS0xFFFFFFFF / sizeof(ESSG_PDATA_T)
ESSG_MAXCOLUMNS0xFFFFFFFF / sizeof(ESSG_DATA_T)
OTHER 
ESSG_MAXROWS0xFFFF / sizeof(ESSG_PDATA_T)
ESSG_MAXCOLUMNS0xFFFF / sizeof(ESSG_DATA_T)

Used by the pAttributes member of the ESSG_DATA_T structure.

ConstantDefinition
ESSG_CA_READONLY0x00000001
ESSG_CA_READWRITE0x00000002
ESSG_CA_LINKEDOBJ0x00000004
ESSG_CA_LINKPARTITION0x00000008
ESSG_CA_LINKCELLNOTE0x00000010
ESSG_CA_LINKWINAPP0x00000020
ESSG_CA_LINKURL0x00000040
ESSG_CA_AISDT0x00000080
ESSG_CA_GLDT0X00000400

Used for the pAttributes for members in the ESSG_DATA_T structure.

ConstantDefinition
ESSG_MA_DIMTOP0x00000001
ESSG_MA_ZOOMINABLE0x00000002
ESSG_MA_NEVERSHARE0x00000004
ESSG_MA_LABELONLY0x00000008
ESSG_MA_STOREDATA0x00000010
ESSG_MA_EXPSHARE0x00000020
ESSG_MA_IMPSHARE0x00000040
ESSG_MA_DYNCALC0x00000080
ESSG_MA_FORMULA0x00000100
ESSG_MA_ATTRIBUTE0x00000200
ESSG_MA_DIMNUMBITS0xF8000000 (the last 5 bits contain the dimension number)

Used by the usType member in the ESSG_DATA_T structure.

ConstantDefinition
ESSG_DT_UNUSED0
ESSG_DT_STRING1
ESSG_DT_LONG2
ESSG_DT_DOUBLE3
ESSG_DT_BLANK4
ESSG_DT_RESERVED5
ESSG_DT_ERROR6
ESSG_DT_MISSING7
ESSG_DT_ZERO8
ESSG_DT_NOACCESS9
ESSG_DT_MEMBER10
ESSG_DT_FORMULA11
ESSG_DT_ZEROwFORMULA12
ESSG_DT_DOUBLEwFORMULA13
ESSG_DT_BLANKwFORMULA14
ESSG_DT_STRINGwFORMULA15
ESSG_DT_MISSINGwFORMULA16
ESSG_DT_NOACCESSwFORMULA17
ESSG_DT_STRINGEX18
ESSG_DT_MEMBEREX19
ESSG_DT_STRINGEXwFORMULA20
ESSG_DT_FORMULAEX21
ESSG_DT_MEMBERwKEY (see ESSG_DT_MEMBERwKEY Example)23
ESSG_DT_SMARTLIST24
ESSG_DT_MNGLESS25
ESSG_DT_DATE26

Note:

When the usType field of the ESSG_DATA_T structure is set to ESSG_DT_MEMBERwKEY, the pszStr field of Value(ESSG_DATA_VALUE) field is interpreted as follows: <length of member name><the member-name><length of key><the key> where the length elements are 2 bytes in size. Note that <the member-name> is null-terminated.

Used by the ulOptions parameter of EssGBeginRetrieve

ConstantDefinition
ESSG_RET_RETRIEVE0
ESSG_RET_RETRIEVELOCK1
ESSG_RET_LOCKONLY2

Used by the ulOptions parameter of EssGBeginUpdate

ConstantDefinition
ESSG_RET_REQUIRELOCK0
ESSG_RET_LOCKIFNEEDED1

This bitmask contant is used by the ulOptions parameter of EssGBeginConditionalRetrieve, EssGBeginConditionalZoomIn, EssGBeginReport, and EssGBeginReportFile

ConstantDefinition
ESSG_NOATTRIBUTES0x00001000

These bitmask constants are used by the ulOptions parameter of EssGBeginZoomIn and EssGBeginConditionalZoomIn

ConstantDefinition
ESSG_ZOOM_DOWN0x00000080
ESSG_ZOOM_ACROSS0x00000100

Describe the connect options

ConstantDefinition
ESSG_CONNECT_DEFAULT0
ESSG_CONNECT_NODIALOG1

Describe the various zoom levels

ConstantDefinition
ESSG_OPTIONS0
ESSG_NEXTLEVEL1
ESSG_ALLLEVELS2
ESSG_BOTTOMLEVEL3
ESSG_SIBLEVEL4
ESSG_SAMELEVEL5
ESSG_SAMEGENERATION6
ESSG_CALCLEVEL7
ESSG_PARENTLEVEL8
ESSG_TOPLEVEL9

Used for setting and retrieving grid options

ConstantDefinition
ESSG_OP_DRILLLEVEL1
ESSG_OP_INCSEL2
ESSG_OP_SELONLY3
ESSG_OP_SELGROUP4
ESSG_OP_INDENT5
ESSG_OP_SUPMISSING6
ESSG_OP_SUPZEROS7
ESSG_OP_SUPUNDER8
ESSG_OP_UPDATEMODE9
ESSG_OP_ALIASNAMES10
ESSG_OP_ALIASTABLE11
ESSG_OP_USERGRIDDATA12
ESSG_OP_RETAINTHREAD20
ESSG_OP_EMPTYGRIDERROR21
ESSG_OP_DRILLONLEAF22
ESSG_OP_DATALESS23
ESSG_OP_SPANHYBRIDANALYSIS24
ESSG_OP_UNIQUENAMEONLY32
ESSG_OP_MEMBERANDUNIQUENAME (see ESSG_OP_MEMBERANDUNIQUENAME Example)33
ESSG_OP_GET_ME_CELLS36

Return #ME (meaningless) value for cells with no base member-attribute combination

Default: off

ESSG_OP_GET_FORMATTED_VALUE38

Include formatting values for formatted cells

Default: Return only cell values

ESSG_OP_GET_VALUE39

Requests original values for cells with non-numeric types

Default: on

ESSG_OP_GET_FORMATTED_MISSING40

Include formatting values for cells with missing values

Default: off

ESSG_OP_GET_DRILLTHRU_URLS41

Populates the drill through flag for cells

Describe the various indent styles

ConstantDefinition
ESSG_INDENTNONE1
ESSG_INDENTSUBITEMS2
ESSG_INDENTTOTALS3

Used by get results calls to determine the process state

ConstantDefinition
ESSG_STATE_DONE1
ESSG_STATE_INPROGRESS2

Buffer length constants (including terminating null)

ConstantDefinition
ESSG_USERNAMELEN31
ESSG_PASSWORDLEN101
ESSG_SERVERLEN31
ESSG_APPLICATIONLEN9
ESSG_DATABASELEN9

Constants used by Grid API Drill-Through functions (EssGDTxxx())

ConstantDefinition
ESSG_DESCRIPTION_LENMaximum buffer length (255) used for report data
ESSG_DTINPUTOPTION_PROMPT_HISNAMEuInputOption value in ESSG_DTINFO_T, meaning that users have all the default values needed to connect to Essbase Studio and start a drill-through session
ESSG_DTINPUTOPTION_PROMPT_LOGINuInputOption value in ESSG_DTINFO_T, meaning that users must set the password to connect to Essbase Studio and start a drill-through session
ESSG_DTREPORT_NAMEMaximum string length (80) used for drill-through
ESSG_ERR_INVALIDDTHANDLEError message constant returned if the given drill-through instance handle is invalid
ESSG_ERR_NODTREPORTSError message constant returned if no drill-through report is defined for the given drill-through instance handle
ESSG_FIELDLENMaximum string length (30) used for drill-through
ESSG_HISDTValue (5) used for drill-through entry

Used by LRO API calls in the structure ESSG_LRODESC_T

ConstantDefinition
ESSG_PARTITIONTYPE1
ESSG_CELLNOTETYPE2
ESSG_WINAPPTYPE3
ESSG_URLTYPE4