C Grid API Constants

The following constants are defined in the Essbase Grid API.

Returned on successful API call.

Constant	Definition
ESSG_STS_NOERR	0

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

Constant	Definition
ESSG_VERSION	0x00040000

Define the maximum number of rows and columns supported

Constant	Definition
WINDOWS
ESSG_MAXROWS	0xFFFFFFFF / sizeof(ESSG_PDATA_T)
ESSG_MAXCOLUMNS	0xFFFFFFFF / sizeof(ESSG_DATA_T)
OTHER
ESSG_MAXROWS	0xFFFF / sizeof(ESSG_PDATA_T)
ESSG_MAXCOLUMNS	0xFFFF / sizeof(ESSG_DATA_T)

Used by the pAttributes member of the ESSG_DATA_T structure.

Constant	Definition
ESSG_CA_READONLY	0x00000001
ESSG_CA_READWRITE	0x00000002
ESSG_CA_LINKEDOBJ	0x00000004
ESSG_CA_LINKPARTITION	0x00000008
ESSG_CA_LINKCELLNOTE	0x00000010
ESSG_CA_LINKWINAPP	0x00000020
ESSG_CA_LINKURL	0x00000040
ESSG_CA_AISDT	0x00000080
ESSG_CA_GLDT	0X00000400

Used for the pAttributes for members in the ESSG_DATA_T structure.

Constant	Definition
ESSG_MA_DIMTOP	0x00000001
ESSG_MA_ZOOMINABLE	0x00000002
ESSG_MA_NEVERSHARE	0x00000004
ESSG_MA_LABELONLY	0x00000008
ESSG_MA_STOREDATA	0x00000010
ESSG_MA_EXPSHARE	0x00000020
ESSG_MA_IMPSHARE	0x00000040
ESSG_MA_DYNCALC	0x00000080
ESSG_MA_FORMULA	0x00000100
ESSG_MA_ATTRIBUTE	0x00000200
ESSG_MA_DIMNUMBITS	0xF8000000 (the last 5 bits contain the dimension number)

Used by the usType member in the ESSG_DATA_T structure.

Constant	Definition
ESSG_DT_UNUSED	0
ESSG_DT_STRING	1
ESSG_DT_LONG	2
ESSG_DT_DOUBLE	3
ESSG_DT_BLANK	4
ESSG_DT_RESERVED	5
ESSG_DT_ERROR	6
ESSG_DT_MISSING	7
ESSG_DT_ZERO	8
ESSG_DT_NOACCESS	9
ESSG_DT_MEMBER	10
ESSG_DT_FORMULA	11
ESSG_DT_ZEROwFORMULA	12
ESSG_DT_DOUBLEwFORMULA	13
ESSG_DT_BLANKwFORMULA	14
ESSG_DT_STRINGwFORMULA	15
ESSG_DT_MISSINGwFORMULA	16
ESSG_DT_NOACCESSwFORMULA	17
ESSG_DT_STRINGEX	18
ESSG_DT_MEMBEREX	19
ESSG_DT_STRINGEXwFORMULA	20
ESSG_DT_FORMULAEX	21
ESSG_DT_MEMBERwKEY (see ESSG_DT_MEMBERwKEY Example)	23
ESSG_DT_SMARTLIST	24
ESSG_DT_MNGLESS	25
ESSG_DT_DATE	26

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

Constant	Definition
ESSG_RET_RETRIEVE	0
ESSG_RET_RETRIEVELOCK	1
ESSG_RET_LOCKONLY	2

Used by the ulOptions parameter of EssGBeginUpdate

Constant	Definition
ESSG_RET_REQUIRELOCK	0
ESSG_RET_LOCKIFNEEDED	1

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

Constant	Definition
ESSG_NOATTRIBUTES	0x00001000

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

Constant	Definition
ESSG_ZOOM_DOWN	0x00000080
ESSG_ZOOM_ACROSS	0x00000100

Describe the connect options

Constant	Definition
ESSG_CONNECT_DEFAULT	0
ESSG_CONNECT_NODIALOG	1

Describe the various zoom levels

Constant	Definition
ESSG_OPTIONS	0
ESSG_NEXTLEVEL	1
ESSG_ALLLEVELS	2
ESSG_BOTTOMLEVEL	3
ESSG_SIBLEVEL	4
ESSG_SAMELEVEL	5
ESSG_SAMEGENERATION	6
ESSG_CALCLEVEL	7
ESSG_PARENTLEVEL	8
ESSG_TOPLEVEL	9

Used for setting and retrieving grid options

Constant	Definition
ESSG_OP_DRILLLEVEL	1
ESSG_OP_INCSEL	2
ESSG_OP_SELONLY	3
ESSG_OP_SELGROUP	4
ESSG_OP_INDENT	5
ESSG_OP_SUPMISSING	6
ESSG_OP_SUPZEROS	7
ESSG_OP_SUPUNDER	8
ESSG_OP_UPDATEMODE	9
ESSG_OP_ALIASNAMES	10
ESSG_OP_ALIASTABLE	11
ESSG_OP_USERGRIDDATA	12
ESSG_OP_RETAINTHREAD	20
ESSG_OP_EMPTYGRIDERROR	21
ESSG_OP_DRILLONLEAF	22
ESSG_OP_DATALESS	23
ESSG_OP_SPANHYBRIDANALYSIS	24
ESSG_OP_UNIQUENAMEONLY	32
ESSG_OP_MEMBERANDUNIQUENAME (see ESSG_OP_MEMBERANDUNIQUENAME Example)	33
ESSG_OP_GET_ME_CELLS	36 Return #ME (meaningless) value for cells with no base member-attribute combination Default: off
ESSG_OP_GET_FORMATTED_VALUE	38 Include formatting values for formatted cells Default: Return only cell values
ESSG_OP_GET_VALUE	39 Requests original values for cells with non-numeric types Default: on
ESSG_OP_GET_FORMATTED_MISSING	40 Include formatting values for cells with missing values Default: off
ESSG_OP_GET_DRILLTHRU_URLS	41 Populates the drill through flag for cells

Describe the various indent styles

Constant	Definition
ESSG_INDENTNONE	1
ESSG_INDENTSUBITEMS	2
ESSG_INDENTTOTALS	3

Used by get results calls to determine the process state

Constant	Definition
ESSG_STATE_DONE	1
ESSG_STATE_INPROGRESS	2

Buffer length constants (including terminating null)

Constant	Definition
ESSG_USERNAMELEN	31
ESSG_PASSWORDLEN	101
ESSG_SERVERLEN	31
ESSG_APPLICATIONLEN	9
ESSG_DATABASELEN	9

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

Constant	Definition
ESSG_DESCRIPTION_LEN	Maximum buffer length (255) used for report data
ESSG_DTINPUTOPTION_PROMPT_HISNAME	uInputOption 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_LOGIN	uInputOption 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_NAME	Maximum string length (80) used for drill-through
ESSG_ERR_INVALIDDTHANDLE	Error message constant returned if the given drill-through instance handle is invalid
ESSG_ERR_NODTREPORTS	Error message constant returned if no drill-through report is defined for the given drill-through instance handle
ESSG_FIELDLEN	Maximum string length (30) used for drill-through
ESSG_HISDT	Value (5) used for drill-through entry

Used by LRO API calls in the structure ESSG_LRODESC_T

Constant	Definition
ESSG_PARTITIONTYPE	1
ESSG_CELLNOTETYPE	2
ESSG_WINAPPTYPE	3
ESSG_URLTYPE	4