BeSpiceWaveParserLimitedEdition
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Macros | Enumerations
af_return_codes.h File Reference

This file contains enum type definitions for the return codes used by the BeSpice interfaces. More...

Go to the source code of this file.

Enumerations

enum  af_return_code {
  af_code_ok = 0, af_code_error = 1, af_code_file_not_found = 2, af_code_parse_failed = 3,
  af_code_licence_expired = 4, af_code_bad_parser_index = 5, af_code_bad_name = 6, af_code_bad_selection = 7,
  af_code_bad_index = 8, af_code_bad_function_arguments = 9, af_code_timeout = 10, af_code_queued = 11,
  af_code_bad_pointer = 12, af_code_thread_error = 13, af_code_interrupted = 14, af_code_unsupported_file_version = 15
}
 

Detailed Description

This file contains enum type definitions for the return codes used by the BeSpice interfaces.

Enumeration Type Documentation

This enum type defines the value returned for some of the functions defined in af_parser.h.

Enumerator
af_code_ok 

the function call succeeded

af_code_error 

the function call failed

af_code_file_not_found 

the file specified in the function call was not found

af_code_parse_failed 

the parsing of the file failed

af_code_licence_expired 

your licence expired

af_code_bad_parser_index 

the parser index is not valid

af_code_bad_name 

the name passed in the function call was not found

af_code_bad_selection 

the current selection is not appropriate for the function call

af_code_bad_index 

the index passed to the function is not valid

af_code_bad_function_arguments 

the function arguments are not valid

af_code_timeout 

a timeout occurred

af_code_queued 

the execution of the command was queued

af_code_bad_pointer 

an invalid pointer was passed to the function

af_code_thread_error 

the function was called from a different thread

af_code_interrupted 

the action was interrupted by the user

af_code_unsupported_file_version 

the version parsed file isn't supported