< Home

< Programming Guide

< Supported File Formats

REFERENCE MANUAL

Enumerations
A3DPDFErrorCodes.h File Reference

Header file for the error codes module. More...

Enumerations

enum  A3DStatus {
  A3D_SUCCESS = 0, A3D_ERROR = -1, A3D_EXCEPTION = -2, A3D_ALLOC_FATAL_ERROR = -10,
  A3D_NOT_IMPLEMENTED = -33, A3D_INVALID_LICENSE = -34, A3D_INVALID_DATA_STRUCT_SIZE = -100, A3D_INVALID_DATA_STRUCT_NULL = -101,
  A3D_INVALID_ENTITY_NULL = -102, A3D_INVALID_ENTITY_TYPE = -103, A3D_INVALID_DATA = -104, A3D_INITIALIZE_ALREADY_CALLED = -200,
  A3D_INITIALIZE_NOT_CALLED = -201, A3D_INITIALIZE_BAD_VALUES = -202, A3D_INITIALIZE_CANNOT_PROCESS = -205, A3D_LOAD_INVALID_FILE_NAME = -10000,
  A3D_LOAD_MULTI_MODELS_CADFILE = -10001, A3D_LOAD_CANNOT_ACCESS_CADFILE = -10002, A3D_LOAD_CANNOT_READ_SETTINGS = -10003, A3D_LOAD_MISSING_COMPONENTS = -10004,
  A3D_LOAD_INVALID_FILE_FORMAT = -10005, A3D_LOAD_READER_NOT_IMPLEMENTED = -10006, A3D_LOAD_CANNOT_LOAD_MODEL = -10007, A3D_LOAD_CANNOT_LOAD_MULTIENTRY = -10008,
  A3D_LOAD_EMPTY_MULTI_MODEL = -10009, A3D_LOAD_INVALID_READER_FOR_INCREMENTAL_LOAD = -10010, A3D_LOAD_INVALID_PARAMETERS_FOR_INCREMENTAL_LOAD = -10011, A3D_LOADPRC_INITIALIZATION_FAILURE = -10300,
  A3D_LOADPRC_CANNOT_OPEN_FILE = -10301, A3D_LOADPRC_READING_ERROR = -10302, A3D_LOADPRC_BUILD_ERROR = -10303, A3D_LOADPRC_PDFLINIT_ERROR = -10304,
  A3D_LOADPRC_INVALID_ANNOT_INDEX = -10305, A3D_LOADPRC_INVALID_ANNOT = -10306, A3D_LOADPRC_EMPTY_FILE = -10307, A3D_LOADPRC_NO_3D = -10308,
  A3D_WRITE_ERROR = -10400, A3D_WRITE_CANNOT_LOAD_WRITER = -10401, A3D_WRITE_WRITER_NOT_IMPLEMENTED = -10402, A3D_WRITE_INVALID_FILE_NAME = -10403,
  A3D_WRITE_INVALID_INPUT = -10404, A3D_CALLBACK_MEMORY_FUNCTIONS_ALREADY_SET = -900000, A3D_CALLBACK_INVALID_BREAK_VALUE = -900001, A3D_CALLBACK_CONTINUE = -900002,
  A3DPDF_PDFLIB_ERROR = -1000000, A3DPDF_ONLY_ONE_PAGE_AUTHORIZED = -1000001, A3DPDF_3D_ANNOT_REQUIRED = -1000002, A3DPDF_ERR_AFTER_SAVE = -1000003,
  A3DPDF_OPT_NOT_PERMITTED = -1000004, A3DPDF_FILE_ALREADY_OPEN = -1000005, A3DPDF_FILE_LOCKED = -1000006, A3DPDF_BAD_FONT_PARAMETERS = -1000007,
  A3DPDF_BAD_PARAMETERS = -1000008, A3DPDF_CANNOT_ACCESS_FILE = -1000009, A3DPDF_UNKNOWN_FIELD = -1000010, A3DPDF_DEFAULT_VIEW_ERROR = -1000011,
  A3DPDF_INVALID_DIMENSIONS = -1000014, A3DPDF_MEMORY_ERROR = -1000015, A3DPDF_CANNOT_FIND_FONT = -1000016, A3DPDF_CANNOT_CREATE_ENCODING = -1000017,
  A3DPDF_CANNOT_CREATE_FONT = -1000018, A3DPDF_CANNOT_CONVERT_PICTURE = -1000019, A3DPDF_CANNOT_SNAPSHOT_VIEW_WITHOUT_CAMERA = -1000020, A3DPDF_CANNOT_LOAD_TABLETOPDF_DLL = -1000021,
  A3DPDF_HTML_TABLE_ERROR = -1000022, A3DPDF_HTML_STYLE_ERROR = -1000023, A3DPDF_CANNOT_INITIALIZE_RESOURCES = -1000024, A3DPDF_INVALID_PAGE_INDEX = -1000025,
  A3DPDF_CANNOT_GENERATE_IMAGE_FROM_VIEW = -1000026, A3DPDF_ANIMATION_NULL_MOTION = -1000027, A3DPDF_SLIDETABLE_NBCOLUMNS_ERROR = -1000028, A3DPDF_SLIDETABLE_TEXTDATA_ERROR,
  A3DPDF_CANNOT_LOAD_IMAGEMAGICK_DLL = -1000031
}
 Error Codes. More...
 

Detailed Description

Header file for the error codes module.

Author
Tech Soft 3D
Version
8.1
Date
February 2015
Copyright (c) 2015 by Tech Soft 3D, LLC. All rights reserved.

As a general rule, every negative value for return codes must be handled as an error, and not simply passed by. When possible, a brief explanation on every case has been provided.

Enumeration Type Documentation

enum A3DStatus

Error Codes.

Enumerator
A3D_SUCCESS 

Successful return value.

A3D_ERROR 

General error.

A3D_EXCEPTION 

Caught exception.

A3D_ALLOC_FATAL_ERROR 

Allocation has failed. Major error.

A3D_NOT_IMPLEMENTED 

Local code, which is not yet implemented.

A3D_INVALID_LICENSE 

License option doesn't allowed the requested function.

A3D_INVALID_DATA_STRUCT_SIZE 

A3D_INITIALIZE_DATA not called or bad alignment in input struct.

A3D_INVALID_DATA_STRUCT_NULL 

Input struct function cannot be NULL.

A3D_INVALID_ENTITY_NULL 

Input entity function cannot be NULL.

A3D_INVALID_ENTITY_TYPE 

Input entity function is of bad type.

A3D_INVALID_DATA 

Input contains bad data.

A3D_INITIALIZE_ALREADY_CALLED 

A3DDllInitialize already called; bad sequence with the A3DDllTerminate function.

A3D_INITIALIZE_NOT_CALLED 

A3DDllInitialize must be called before calling the A3DDllTerminate function.

A3D_INITIALIZE_BAD_VALUES 

Initialization led to bad internal values for globals. Fatal error. Reinitialize program.

A3D_INITIALIZE_CANNOT_PROCESS 

Cannot initialize library.

A3D_LOAD_INVALID_FILE_NAME 

Input file does not correspond to a valid file name.

A3D_LOAD_MULTI_MODELS_CADFILE 

Input CAD file correspond to a multi model file.

A3D_LOAD_CANNOT_ACCESS_CADFILE 

Cannot access input CAD file.

A3D_LOAD_CANNOT_READ_SETTINGS 

Cannot access CAD reading settings file.

A3D_LOAD_MISSING_COMPONENTS 

One or several components are missing.

A3D_LOAD_INVALID_FILE_FORMAT 

Input file seems invalid.

A3D_LOAD_READER_NOT_IMPLEMENTED 

The reader is not implemented.

A3D_LOAD_CANNOT_LOAD_MODEL 

An error occurred during parsing.

A3D_LOAD_CANNOT_LOAD_MULTIENTRY 

Cannot load multi-entry file.

A3D_LOAD_EMPTY_MULTI_MODEL 

Empty model.

A3D_LOAD_INVALID_READER_FOR_INCREMENTAL_LOAD 

Invalid reader for incremental load.

A3D_LOAD_INVALID_PARAMETERS_FOR_INCREMENTAL_LOAD 

Invalid parameters for incremental load.

A3D_LOADPRC_INITIALIZATION_FAILURE 

Cannot initialize reading context.

A3D_LOADPRC_CANNOT_OPEN_FILE 

Cannot open file.

A3D_LOADPRC_READING_ERROR 

Internal reading error.

A3D_LOADPRC_BUILD_ERROR 

Internal reading error - Invalid PRC file.

A3D_LOADPRC_PDFLINIT_ERROR 

Error while initializing PDFL.

A3D_LOADPRC_INVALID_ANNOT_INDEX 

Input annotation index is invalid.

A3D_LOADPRC_INVALID_ANNOT 

Input annotation is invalid.

A3D_LOADPRC_EMPTY_FILE 

Input file is empty.

A3D_LOADPRC_NO_3D 

Input file does not contain any 3D Annot.

A3D_WRITE_ERROR 

Error while writing export file.

A3D_WRITE_CANNOT_LOAD_WRITER 

Cannot load writer.

A3D_WRITE_WRITER_NOT_IMPLEMENTED 

The writer is not implemented.

A3D_WRITE_INVALID_FILE_NAME 

Input file does not correspond to a valid file name.

A3D_WRITE_INVALID_INPUT 

Input file does not correspond to a valid file name.

A3D_CALLBACK_MEMORY_FUNCTIONS_ALREADY_SET 

A3DDllSetCallbacksMemory can be called only once per session.

A3D_CALLBACK_INVALID_BREAK_VALUE 

A3DDllSetCallbacksProgress : lBreak must be a valid pointer (not NULL).

A3D_CALLBACK_CONTINUE 

A3DDllSetCallbacksProgress : lBreak must be a valid pointer (not NULL).

A3DPDF_PDFLIB_ERROR 

Unexpected PDFLib Error.

A3DPDF_ONLY_ONE_PAGE_AUTHORIZED 

A3DPDFDocumentCreateUniquePage can be called only on an empty document.

A3DPDF_3D_ANNOT_REQUIRED 

Cannot call A3DPDFDocumentSave without a 3D Annot in the document.

A3DPDF_ERR_AFTER_SAVE 

A3DPDFDocumentSave : document has not been saved properly.

A3DPDF_OPT_NOT_PERMITTED 

A3DPDFDocumentSave : invalid options.

A3DPDF_FILE_ALREADY_OPEN 

A3DPDFDocumentSave : file is already opened in another application.

A3DPDF_FILE_LOCKED 

A3DPDFDocumentSave : file is locked by another application.

A3DPDF_BAD_FONT_PARAMETERS 

A3DPDFPageInsertText : bad font parameters.

A3DPDF_BAD_PARAMETERS 

Bad parameters.

A3DPDF_CANNOT_ACCESS_FILE 

Cannot access file.

A3DPDF_UNKNOWN_FIELD 

Cannot find the specified field in the document.

A3DPDF_DEFAULT_VIEW_ERROR 

Cannot find a default view in 3D Annot.

A3DPDF_INVALID_DIMENSIONS 

Width and height must be >0 and <=682.

A3DPDF_MEMORY_ERROR 

Not enough memory.

A3DPDF_CANNOT_FIND_FONT 

Cannot find the specified font.

A3DPDF_CANNOT_CREATE_ENCODING 

Cannot create the specified encoding.

A3DPDF_CANNOT_CREATE_FONT 

Cannot create the specified font.

A3DPDF_CANNOT_CONVERT_PICTURE 

Cannot convert the specified picture.

A3DPDF_CANNOT_SNAPSHOT_VIEW_WITHOUT_CAMERA 

In a PRC/PDF file, there is a view without a camera; snapshots cannot be created from such views.

A3DPDF_CANNOT_LOAD_TABLETOPDF_DLL 

tabletopdf.dll or one of its components is missing from your directory.

A3DPDF_HTML_TABLE_ERROR 

Wrong HTML format for table entry.

A3DPDF_HTML_STYLE_ERROR 

Wrong HTML format for style entry.

A3DPDF_CANNOT_INITIALIZE_RESOURCES 

Resource directory could not be initialized. Please check you used A3DPDFInitializePDFLibAndResourceDirectory with a correct path.

A3DPDF_INVALID_PAGE_INDEX 

Input page index is invalid or not in pages bounds.

A3DPDF_CANNOT_GENERATE_IMAGE_FROM_VIEW 

Error while generating the images for the buttons in the view carousel.

A3DPDF_ANIMATION_NULL_MOTION 

At least one motion is null, the animation can't be created.

A3DPDF_SLIDETABLE_NBCOLUMNS_ERROR 

The number of columns in the table frame is different than the number of columns in text data.

A3DPDF_SLIDETABLE_TEXTDATA_ERROR 

Error in text data (ppTexts argument). pdflib DLL or one of its components is missing.

A3DPDF_CANNOT_LOAD_IMAGEMAGICK_DLL 

ImageMagick DLL or one of its components is missing.