Appendix B:
Error Codes
|
The error codes that are produced by PGSDK are divided into the following groups: |
||
|
|
System Wide Errors (#define E00_BASE 0x0000) |
|
|
|
2D Engine Errors (#define E2D_BASE 0x0200) |
|
|
|
3D Engine Errors (#define E3D_BASE 0x0300) |
|
|
|
Annotation Engine Errors (#define EAN_BASE 0x0500) |
|
|
|
Standard Access Errors (#define EAC_BASE 0x0600) |
|
|
|
Standard Draw Errors (#define EDR_BASE 0x0700) |
|
|
|
Special Effects Errors (#define EFX_BASE 0x0800) |
|
|
The error codes in each group are generally defined in the following classes to indicate the severity of the error. These are defined in the ERROR_CLASSES enum: |
||
|
|
ERRCLASS_STATUS: not an error, return of status |
|
|
|
ERRCLASS_WARNING: recoverable error, no user intervention |
|
|
|
ERRCLASS_FATAL; fatal error |
|
|
|
ERRCLASS_CONFIRM: recoverable error, requires user confirmation |
|
|
|
ERRCLASS_SPECIAL: recoverable error, requires user to make a multiple-choice |
|
System Wide Errors (E00_)
|
The following system-wide error codes are defined in the E00_ERROR_CODES enum: |
||
|
E00_ERROR_CODES values |
Description |
|
|
E00_OK |
STATUS: Indicates successful function return result |
|
|
E00_DISK_FULL |
WARNING: Insufficient disk space |
|
|
E00_FATAL_ERROR |
FATAL: Internal error |
|
|
E00_FILE_CLOSE_ERROR |
WARNING: file close error |
|
|
E00_FILE_NOT_FOUND |
WARNING: file not found |
|
|
E00_FILE_READ_ERROR |
WARNING: file read error |
|
|
E00_FILE_SEEK_ERROR |
WARNING: file seek error |
|
|
E00_INVALID_NULL_ARG |
WARNING: NULL argument not valid here |
|
|
E00_MEM_ERROR |
WARNING: out of memory |
|
|
E00_NOT_IMPLEMENTED |
WARNING: Function not implemented |
|
|
E00_RANGE_ERROR |
WARNING: Out of range error. |
|
|
E00_USER_BREAK |
STATUS: User interrupted function by pressing escape |
|
|
E00_USER_CANCEL |
STATUS: User canceled from dialog |
|
|
E00_SINGLE_SERIES |
WARNING: Multiple series required. |
|
|
E00_SINGLE_GROUP |
WARNING: Multiple groups required. |
|
|
E00_NOT_SPLITY_DATA |
WARNING: Nothing assigned to Split Y axis, assigning half arbitrarily. |
|
|
E00_NO_DATA |
WARNING: No data found. |
|
|
E00_SERIESID_ERROR |
STATUS: Illegal series address reference. |
|
|
E00_INVALID_STRUCT_SIZE |
ERROR: Passed structure wrong size. |
|
|
E00_DOMAIN_ERROR |
ERROR: Illegal value. |
|
|
E00_DDE_INIT |
DDE initialization failure. |
|
|
E00_FILE_WRITE_ERROR |
File write error |
|
|
E00_FILE_OPEN_ERROR |
File is already open from another application |
|
|
E00_FILE_NOTEXCEL |
Non-excel file opened as Excel |
|
|
E00_FILE_NOTTEXT |
Non-TEXT file opened as TEXT |
|
|
E00_SMARTFILL_NOMATCH |
SmartFill couldn't match the text |
|
|
E00_SMARTFILL_BADCELL |
Wrong type of cell for SmartFill |
|
|
E00_FILE_DELETE_ERROR |
Error deleting a file |
|
|
E00_INVALID_PARAMETER |
Invalid Parameter |
|
2D Engine Errors (E2D_)
|
The following 2D Engine error codes are defined in the E2D_ERROR_CODES enum: |
||
|
E2D_ERROR_CODES values |
Description |
|
|
E2D_GEN_ERROR |
General 2D error code |
|
|
E2D_MEMERR |
WARNING: Memory allocation problem. |
|
|
E2D_ERRBSTACKED |
WARNING: Error bars not supported by stacked chart types. |
|
|
E2D_LEGENDCOLOR |
CONFIRM: Legend box not applicable to group colored area chart. |
|
|
E2D_PERCENTLOG |
WARNING: Logarithmic scale not applicable to percent chart. |
|
|
E2D_NEGLOG |
WARNING: Negative values not possible on logarithmic scale. |
|
|
E2D_ZEROLOG |
WARNING: Zero value requires infinite range with logarithmic scale. |
|
|
E2D_CONTOURBSPL |
WARNING: Less than two number of vertices on BSplines. |
|
|
E2D_CONTOURLOG, |
WARNING: Zero or negative values require infinite range with logarithmic scale. |
|
|
E2D_CONTOURSTEP |
WARNING: Zero or negative intervals are not applicable. |
|
|
E2D_CONTOURLEVELS |
WARNING: Zero or negative number of Contour Levels are not applicable. |
|
|
E2D_CONTOURSURFACE |
WARNING: Zero or negative number of Contour Surfaces are not applicable. |
|
|
E2D_CONTOURPOINTS |
WARNING: Negative number of Contour Points are not applicable. |
|
|
ETC_DC_OVERFLOW |
Current table chart overflows DC - set to all autofit. |
|
|
E2D_BADORIENTATION |
Horizontal orientation in a vertical-only chart or vice versa |
|
|
E2D_RR_BADMINMAX |
One or more min/max values were invalid. |
|
3D Engine Errors (E3D_)
|
The following 3D engine error codes are defined in the E3D_ErrorCodes enum: |
||
|
E3D_ErrorCodes |
Description |
|
|
E3D_CODE_NUMTOPOLINES |
WARNING. More topo lines (grids, contours...) were generated than predicted. This error is a sign of a corrupted .3D3 file and "should" never occur in real life. |
|
|
E3D_CODE_ODDTOPOPOINTS |
WARNING. This error indicates an internal program bug - helpful during development, but, like the error above, "should" never occur. |
|
|
E3D_CODE_BADCOLORMAP |
FATAL. Invalid color mapping code (trapped when calculating area and line ID bins). |
|
|
E3D_CODE_BADOBJID |
FATAL. Invalid object ID, probably out of range. |
|
|
E3D_MAC_GDEVICE |
WARNING. MAC Specific Error: A Mac-specific error indicating that the program was unable to obtain graph device information from the O/S. |
|
|
E3D_WIN_COLORTABLE |
WARNING. Windows-Specific Error: WINDOWS didn't let us to allocate a color table probably due to memory shortage. |
|
|
E3D_WIN_PIPPIX |
WARNING. Windows-Specific Error: WINDOWS didn't let us allocate an offscreen picture handle. |
|
|
E3D_MEM_3DSTRINGALLOC |
WARNING. Memory Error: Unable to allocate memory for a text string. |
|
|
E3D_MEM_AUTOFIT |
WARNING. Memory Error: Unable to allocate memory for autofit struct. |
|
|
E3D_MEM_FRAME |
WARNING. Memory Error: Unable to allocate memory for graph frame information structure. |
|
|
E3D_MEM_LABELINFO |
WARNING. Memory Error: Unable to allocate memory for array of header strings. |
|
|
E3D_MEM_LINEALLOC |
WARNING. Memory Error: Unable to allocate memory for buffer for grid-, topo- etc. lines. |
|
|
E3D_MEM_MATRIXSORT |
WARNING. Memory Error: Unable to allocate memory for structure for sorting cells in matrix-type graphs (ordinal x & z axes) = non-scatters. |
|
|
E3D_MEM_NEWPOLY |
WARNING. Memory Error: Unable to allocate memory for copy of polygon for clipping purposes. |
|
|
E3D_MEM_OBJECT |
WARNING. Memory Error: Unable to allocate memory for 3D object definition structure. |
|
|
E3D_MEM_PIXELBATCH |
WARNING. Memory Error: Unable to allocate memory for pixel buffer for 3D raytracing. |
|
|
E3D_MEM_RAYSTRUCT |
WARNING. Memory Error: Unable to allocate memory for information structure for 3D raytracing. |
|
|
E3D_MEM_SCATTERCLOUDS |
WARNING. Memory Error: Unable to allocate memory for list of data point location in scatter graphs (used to improve rotation speed). |
|
|
E3D_MEM_SCATTERSORT |
WARNING. Memory Error: Unable to allocate memory for structure for sorting marker points by distance from viewer in scatter graphs. |
|
|
E3D_MEM_SINTABLE |
WARNING. Memory Error: Unable to allocate memory for table of 90 precalculated sine values. |
|
|
E3D_MEM_STROKESTRINGALLOC |
WARNING. Memory Error: Unable to allocate memory for table of strings for ATM type text. |
|
|
E3D_MEM_TOPOENDPOINTS |
WARNING. Memory Error: Unable to allocate memory for list of endpoints of topo lines. |
|
|
E3D_MEM_TOPOLINELIST |
WARNING. Memory Error: Unable to allocate memory for list of topolines themselves. |
|
|
E3D_RANGE_ATTR |
WARNING. OUT-OF-RANGE error for object attribute. |
|
|
E3D_RANGE_GRAPHTYPE_1 |
WARNING. OUT-OF-RANGE error for invalid graph type for matrix graphs. |
|
|
E3D_RANGE_GRAPHTYPE_2 |
WARNING. OUT-OF-RANGE error reserved for invalid scatter type. |
|
|
E3D_DATA_SCATTERPOINT |
No or bad data for scatter point. |
|
|
E3D_GEN_ERROR |
General 3D Error |
|
Annotation Engine Errors (EAN_)
|
The following annotation engine error codes are defined in the EAN_ErrorCodes enum: |
||
|
EAN_ErrorCodes |
Description |
|
|
EAN_MEM_NEWANODE |
ALERT. Error creating anode. |
|
|
EAN_MEM_GROUP |
ALERT. Error grouping anodes. |
|
|
EAN_MEM_DUPLICATE |
ALERT. Error duplicating. |
|
|
EAN_SETTEXT |
ALERT. Invalid text handle encountered or out of memory while setting text. |
|
|
EAN_BADGRAPH |
ALERT. Invalid GraphPtr passed to engine |
|
|
EAN_BADATTR |
ALERT. Attribute passed was not valid |
|
|
EAN_BADANODE |
ALERT. An Invalid Annotation handle was passed |
|
|
EAN_NOANODES |
ALERT. The selection list contained no annotations to act upon. |
|
|
EAN_NODETNODEFOUND |
ALERT. No detection node was found for given Anode |
|
|
EAN_NOLINKOBJECT |
ALERT. Hot-Link found no graph object to link to in the selection list |
|
|
EAN_DATAINVALID |
ALERT. Attribute codes or menu information is invalid |
|
Standard Access Errors (EAC_)
|
The following standard access error codes are defined in the EacErrorCodes enum: |
||
|
EacErrorCodes |
Description |
|
|
EAC_INVALIDSERIES |
FATAL. Series address out of range. |
|
|
EAC_INVALIDGROUPS |
FATAL. Group address out of range. |
|
|
EAC_INVALIDENTRY |
FATAL. Entry address out of range. |
|
|
EAC_BUFFEROVERFLOW |
FATAL. Insuffient space in buffer. |
|
|
EAC_UNKNOWNCHART |
FATAL. Chart type not found in data structures. |
|
|
EAC_NULLITEM |
FATAL. Attempt was made to query an empty item. |
|
|
EAC_GETSTORAGE |
FATAL. Storage device was unable to retrieve data. |
|
|
EAC_PUTSTORAGE |
FATAL. Storage device was unable to store data. |
|
|
EAC_EMPTYRANGE |
FATAL. Operation failed due to lack of data. |
|
|
EAC_NOTIMPLEMENTED |
FATAL. Function not implemented in this version. |
|
|
EAC_INVALIDITEM |
FATAL. Item not valid in context used. |
|
|
EAC_EMPTYDATAFORMAT |
FATAL. No data items active in node. |
|
|
EAC_NULL_DATARANGE |
Data range undefined. |
|
|
EAC_NO_DATA |
Insufficient data to form any risers. |
|
|
EAC_TOOFEW_SERIES |
At least two series required for this graph. |
|
|
EAC_TOOFEW_GROUPS |
At least two groups required for this graph. |
|
|
EAC_NEG_LOG |
||
|
EAC_ZERO_LOG |
||
|
EAC_INVALIDPAGE |
Page address out of range. |
|
Standard Draw Errors (EDR_)
|
The following standard drawing error codes are defined in the EDR_ERROR_CODES enum: |
||
|
EDR_ERROR_CODES |
Description |
|
|
EDR_INVALID_DETNODEREF |
Invalid Detection Node Reference |
|
|
EDR_INVALID_DETNODEPTR |
Invalid Detection Node Pointer |
|
|
EDR_ITEM_NOT_FOUND |
Item Not Found |
|
|
EDR_MISSING_SFX_FILE |
Missing Special Effects File |
|
|
EDR_NULL_AREAINST |
Null Area Instance |
|
|
EDR_NULL_FONTINST |
Null Font Instance |
|
|
EDR_NULL_LINEINST |
Null Line Instance |
|
|
EDR_CREATE |
||
|
EDR_COMBINE |
||
|
EDR_SELECT |
||
Special Effects Errors (EFX_)
|
The following special effects error codes are defined in the EFX_ErrorCodes enum: |
||
|
EFX_ErrorCodes |
Description |
|
|
EFX_MEM_NEWSFX |
WARNING. Error creating SFXHandle. Probably Memory |
|
|
EFX_BAD_PICT |
WARNING. Error opening picture file |
|
|
EFX_BAD_PATH |
WARNING. TDGPATH not set to picture's path |
|
|
EFX_UNKNOWN_PICT |
WARNING. Unrecognized picture format |
|
|
EFX_BAD_EXTENTS |
WARNING. Metafile extents are zero'd |
|
|
EFX_NULL_SFX |
WARNING. A NULL SFXHandle was passed |
|
|
EFX_COLOR_RANGE |
WARNING. An out-of-range palette index was referenced |
|
|
EFX_OPEN_PRESETS |
WARNING. Error opening preset file |
|
|
EFX_WRITE_PRESETS |
WARNING. Error writing preset file |
|
|
EFX_READ_PRESETS |
WARNING. Error reading preset file |
|
|
EFX_NO_PRESET |
WARNING. No preset by that name exists |
|
|
EFX_NOLAYERS |
WARNING. No layers were drawn in SFX |
|
