The C Grid API returns three types of error codes:
Success—API returns a zero value
Server error—API returns a very large number. These numbers are described in the file esserror.h
API error—API returns numbers beginning with 1100001. These values are defined in the Grid API C language header file essgapi.h.
If you provide a valid Error Function callback when you initialize the Grid API, this callback is called for all EGAPI errors if a valid hGrid is passed. The Error Function can in turn stop the default error handling user interface provided within EGAPI by returning zero (0). If a non-zero value is returned from the Error Function, or no Error Function is provided, EGAPI uses the system specific user interface to display the error message.
The following table describes the error status constants returned when a Grid API call fails.
| Error Code | Value |
|---|---|
| ESSG_ERR_INITREQUIRED | 1100001 |
| ESSG_ERR_CONNECTREQUIRED | 1100002 |
| ESSG_ERR_INVALIDHANDLE | 1100003 |
| ESSG_ERR_INVALIDGRID | 1100004 |
| ESSG_ERR_CANNOTINIT | 1100005 |
| ESSG_ERR_CANNOTCONNECT | 1100006 |
| ESSG_ERR_CANNOTCREATEGRID | 1100007 |
| ESSG_ERR_INVALIDVERSION | 1100008 |
| ESSG_ERR_CANNOTGETAPIINST | 1100009 |
| ESSG_ERR_CANNOTGETAPICTX | 1100010 |
| ESSG_ERR_INVALIDOPTION | 1100011 |
| ESSG_ERR_INVALIDRANGE | 1100012 |
| ESSG_ERR_INVALIDDATA | 1100013 |
| ESSG_ERR_INVALIDROWORCOLMAX | 1100014 |
| ESSG_ERR_NULLARGUMENT | 1100015 |
| ESSG_ERR_CELLSREQUIRED | 1100016 |
| ESSG_ERR_RANGEREQUIRED | 1100017 |
| ESSG_ERR_INVALIDACTION | 1100018 |
| ESSG_ERR_INVALIDGRIDOPTION | 1100019 |
| ESSG_ERR_INVALIDFUNCTION | 1100020 |
| ESSG_ERR_MEMORY | 1100021 |
| ESSG_ERR_INVALIDROW | 1100022 |
| ESSG_ERR_INVALIDCOLUMN | 1100023 |
| ESSG_ERR_INVALIDPARM | 1100024 |
| ESSG_ERR_INVALIDCSLVERSION | 1100025 |
| ESSG_ERR_RANGEOVERLAP | 1100026 |
| ESSG_ERR_OPERATIONFAILED | 1100027 |
| ESSG_ERR_CANNOTSETOPTION | 1100028 |
| ESSG_ERR_INVALIDOPTIONVALUE | 1100029 |
| ESSG_ERR_EMPTYARGUMENT | 1100030 |
| ESSG_ERR_INVALIDLROHANDLE | 1100031 |
| ESSG_ERR_NOLROSAVAILABLE | 1100032 |
| ESSG_ERR_INVALIDLROTYPE | 1100033 |
| ESSG_ERR_GCINITFAIL | 1100034 |
| ESSG_ERR_GCSETLOCALEFAIL | 1100035 |