Error Return Values

The following table describes the error status constants returned when an Outline API call fails. These values are defined in the Essbase Outline API C language header file esserror.h.

Value Description
OTLAPI_BAD_ALIASTABLE Illegal alias table
OTLAPI_BAD_CONSOL Invalid consolidation type (+,-,etc.)
OTLAPI_BAD_GENLEVELNAME Invalid generation or level name
OTLAPI_BAD_HOUTLINE Invalid outline handle passed to EssOtl... function
OTLAPI_BAD_MBRNAME Invalid member name
OTLAPI_BAD_MEMBER Invalid member handle
OTLAPI_BAD_MOVE Illegal move of member. Can't move member to its descendant.
OTLAPI_BAD_OBJTYPE Illegal object type
OTLAPI_BAD_OUTLINETYPE Invalid outline type
OTLAPI_BAD_RENAMESHARE A shared member cannot be renamed
OTLAPI_BAD_RESTRUCTTYPE Invalid restructure type
OTLAPI_BAD_SORT COMPAREFUNC Invalid sorting compare function
OTLAPI_BAD_SORTTYPE Invalid sort type
OTLAPI_BAD_TRANSTYPE Unknown transaction type when creating a transaction (internal error)
OTLAPI_BAD_USERATTR Invalid user attribute
OTLAPI_CUR_NOACCOUNTS There is no Accounts dimension. You need an Accounts dimension to create a currency database.
OTLAPI_CUR_NOCOUNTRY There is no Country dimension. You need a Country dimension to create a currency database.
OTLAPI_CUR_NOTIME There is no Time dimension. You need a Time dimension to create a currency database.
OTLAPI_ERR_ADDNAMEUSED Member name already used (add operation)
OTLAPI_ERR_ALIASSHARED A shared member cannot have an alias
OTLAPI_ERR_ALIASTABLEEXISTS Alias table already exists
OTLAPI_ERR_ALIASTABLENAME Illegal alias table name
OTLAPI_ERR_ALREADY CURRENCY The outline is a currency outline. You are trying to create a currency outline, and the initial outline is already a currency outline.
OTLAPI_ERR_BADSHARE Illegal share value
OTLAPI_ERR_BADSKIP Illegal time balance skip value
OTLAPI_ERR_BADSTORAGE Illegal dimension storage value
OTLAPI_ERR_BADSTORAGE CATEGORY Illegal storage category
OTLAPI_ERR_BADTIMEBAL Illegal time balance value
OTLAPI_ERR_CONFIGTOOMANY DIMS Too many dimensions to configure automatically
OTLAPI_ERR_COPYALIASTABLE Source and destination tables are the same.
OTLAPI_ERR_CREATETEMP Cannot create temporary file name. You are probably trying to create it on a read-only drive. We create a temporary file on the client every time you open or write an outline from/to the server.
OTLAPI_ERR_CURTOOMANYDIMS Too many dimensions in a currency outline A currency outline is limited to four dimensions.
OTLAPI_ERR_DELETEDEFALIAS Cannot delete the default alias table
OTLAPI_ERR_DUPLICATEALIAS Duplicate alias
OTLAPI_ERR_DUPLICATENAME Duplicate member name
OTLAPI_ERR_DUPGENLEVNAME Cannot add, rename, or set a member name or alias that duplicates a generation or level name.
OTLAPI_ERR_FILEIO Could not read from or write to file
OTLAPI_ERR_FILEOPEN Could not open file
OTLAPI_ERR_GENLEVELEXISTS Generation or level already has a name
OTLAPI_ERR_GENLEVELNAME EXISTS Generation or level name already exists
OTLAPI_ERR_GENLEVELVALUE Illegal generation or level value
OTLAPI_ERR_GENLEVNAMEMBR Cannot add a generation or level name that duplicates a member name or alias
OTLAPI_ERR_ILLEGALALIAS STRING Illegal member combinational for alias
OTLAPI_ERR_ILLEGALCOMBOALIAS Illegal combinational alias name
OTLAPI_ERR_ILLEGALCURRENCY Illegal currency member
OTLAPI_ERR_ILLEGALDEFALIAS Illegal default alias name
OTLAPI_ERR_ILLEGALNAME Illegal member name
OTLAPI_ERR_ILLEGALTAG Illegal dimension tag (category)
OTLAPI_ERR_INVALIDOPTIONOccurs when the user passes in an invalid option to EssOtlGetGenNames() or EssOtlGetLevelNames().
OTLAPI_ERR_LEAFLABEL Leaf member defined as a label member
OTLAPI_ERR_MAXALIASTABLES Maximum number of alias tables has been reached
OTLAPI_ERR_MEMBERCALC Illegal member formula
OTLAPI_ERR_MEMBERCOMMENTEXLEN Extended member comment is too long
OTLAPI_ERR_NOALIAS No alias for this member
OTLAPI_ERR_NOALIASCOMBO No alias combination
OTLAPI_ERR_NOFORMULA No formula for this member
OTLAPI_ERR_NOSHAREPROTO Shared member with no actual member
OTLAPI_ERR_NOTADIM Dimension name expected
OTLAPI_ERR_NOTIMEDIM No time dimension defined (can't do time balance operations without a time dimension)
OTLAPI_ERR_NOTVERIFIED Outline has errors (when saving to the server)
OTLAPI_ERR_OPENMODE File was opened in the wrong mode to make this call. If you call EssOtlOpenOutlineQuery() to open the outline, not all of the calls will work.
OTLAPI_ERR_RENAMEDEFALIAS Cannot rename the default alias table
OTLAPI_ERR_RENAME NAMEUSED Member name already used (rename operation)
OTLAPI_ERR_SHAREDMEMBER FORMULA
Shared member cannot have a formula
OTLAPI_ERR_SHARENOTLEVEL0 Shared member not at level 0 (a shared member cannot be a parent of another member)
OTLAPI_ERR_SHAREUDA Cannot set a user attribute for a shared member.
OTLAPI_ERR_TIMESPARSE Accounts dimension is dense and time dimension sparse-Not used
OTLAPI_NO_GENLEVELNAME Cannot find generation or level name
OTLAPI_NO_USERATTR Cannot find user attribute
OTLAPI_NULL_ARG NULL argument passed to EssOtl... function
OTLAPI_SORT_TOOMANY Too many members to sort (64K / 4 members is the maximum sorting capacity)