Main Page | Features | Central Services | csv-Files | Types | Transfer | Access | API-C | API-.NET | API-Java | Examples | Downloads
page generated on 18.05.2024 - 04:45
Enumerations | Functions
errors.h File Reference

Enumerations

enum  TErrorList {
  operation_success = 0, illegal_line = 1, illegal_format = 2, illegal_arithmetic = 3,
  ambiguous = 4, illegal_delimiter = 5, zero_divide = 6, work_area_full = 7,
  non_existent = 8, invalid_transport = 9, data_size_mismatch = 10, no_data_in_range = 11,
  un_allocated = 12, no_such_line = 13, illegal_data_size = 14, io_error = 15,
  illegal_context = 16, runtime_error = 17, system_error = 18, hardware_busy = 19,
  argument_list_error = 20, invalid_parameter = 20, file_error = 21, use_stream_transport = 22,
  dimension_error = 23, square_root_negative = 24, buffer_too_small = 25, string_too_long = 26,
  ipx_socket_error = 27, net_read_error = 28, not_ready = 29, invalid_transport_size = 30,
  log_negative = 31, device_not_connected = 32, unauthorised_action = 33, hardware_error = 34,
  illegal_equipment_number = 35, illegal_device_number = 35, illegal_device = 35, illegal_property = 36,
  out_of_range = 37, not_implemented = 38, no_such_computer = 39, struct_sealed = 40,
  syntax_error = 41, no_such_file = 42, file_already_exists = 43, no_file_space = 44,
  link_not_open = 45, link_timeout = 45, remitted_data_lost = 46, end_of_file = 47,
  archive_busy = 48, server_name_in_use = 49, no_such_column = 50, out_of_client_memory = 51,
  mcast_access_required = 52, address_unresolved = 53, invalid_property = 54, address_unknown = 55,
  name_unknown = 56, invalid_keyword = 57, invalid_link = 58, string_expected = 59,
  out_of_local_memory = 60, out_of_shared_memory = 61, invalid_structure_tag = 62, invalid_index = 63,
  illegal_equipment_name = 64, link_error = 65, code_failure = 66, non_existent_server = 67,
  function_deprecated = 68, not_supported = 69, illegal_character = 70, parsing_error = 70,
  illegal_operator = 71, not_allowed = 72, illegal_read_write = 73, out_of_server_memory = 74,
  database_not_loaded = 75, illegal_command = 76, resources_exhausted = 77, header_not_found = 78,
  sedac_error = 79, reacquire_address = 80, semaphore_error = 81, driver_not_installed = 82,
  port_not_available = 83, async_access_required = 84, semaphore_busy = 85, non_existent_elem = 86,
  non_existent_fec = 87, non_existent_client = 88, cannot_lock = 89, not_running = 90,
  not_posted = 91, not_accepted = 92, operation_timeout = 93, illegal_protocol = 94,
  gpib_error = 95, rs232_error = 96, operation_busy = 97, connection_timeout = 98,
  illegal_mode = 99, not_owner = 100, not_defined = 101, net_write_error = 102,
  invalid_data = 103, software_error = 104, access_denied = 105, tcp_not_supported = 106,
  ipx_not_supported = 107, host_not_resolved = 108, tcp_connect_error = 109, tcp_socket_error = 110,
  configuration_error = 111, invalid_return_code = 112, link_blacklisted = 113, link_exists = 114,
  max_alarms_exceeded = 115, not_exported = 116, is_switching = 117, at_limit = 118,
  get_subscription_id = 119, renegotiate_contract = 120, server_redirection = 121, value_too_high = 122,
  value_too_low = 123, warn_too_high = 124, warn_too_low = 125, completion_waiting = 126,
  cannot_select = 127, has_query_function = 128, not_signalled = 129, call_redirection = 130,
  udp_socket_error = 131, mutex_error = 132, data_not_local = 133, name_already_exists = 134,
  already_assigned = 135, invalid_field = 136, mcast_init_error = 137, invalid_mcast_group = 138,
  non_existent_function = 139, property_is_mca = 140, invalid_name = 141, invalid_value = 142,
  device_error = 143, device_not_ready = 144, device_busy = 145, invalid_interval = 146,
  notification_pending = 147, thread_error = 148, is_terminating = 149, name_server_unknown = 150,
  lock_required = 151, not_initialized = 152, invalid_structure_size = 153, canbus_error = 154,
  profibus_error = 155, data_stale = 156, has_bitfield_tag = 157, not_locked = 158,
  lock_expired = 159, not_registered = 160, non_existent_property = 161, memory_overwrite = 162,
  server_idle = 163, not_applicable = 164, access_locked = 165, invalid_reference = 166,
  has_structure_tag = 167, warn_disk_space = 168, low_disk_space = 169, information_static = 170,
  reset_mca_property = 171, record_too_long = 172, unix_socket_error = 173, pipe_error = 173,
  shm_error = 174, tcp_connection_closed = 175, service_unavailable = 176, device_offline = 177,
  out_of_sequence = 178, invalid_datarequest = 179, property_is_mca_elevated = 180, name_not_found = 181,
  out_of_tolerance = 182, file_not_open = 183, low_main_memory = 184, tcp_access_required = 185
}
 

Functions

TINE_EXPORT char * GetErrorText (int code, char *errstr, int length)
 Returns the error text associated with an error code. More...
 
TINE_EXPORT int RegisterErrorCode (int code, char *msgShort, char *msgLong)
 Registers the error code given and associates with the given message strings. More...
 

Detailed Description

<

system error code definitions

Enumeration Type Documentation

◆ TErrorList

enum TErrorList
Enumerator
operation_success 

successful completion

illegal_line 

illegal line number

illegal_format 

illegal format or data type

illegal_arithmetic 

illegal arithmetic expression

ambiguous 

ambigous input information

illegal_delimiter 

illegal delimiter in expression

zero_divide 

divide by zero

work_area_full 

working area buffer is full

non_existent 

requested target does not exist

invalid_transport 

transport medium is not valid

data_size_mismatch 

incoming data payload larger than requested ?

no_data_in_range 

no data found in input range

un_allocated 

requested target is not allocated in the given context

no_such_line 

expected line not found in database

illegal_data_size 

give data size is illegal or not valid

io_error 

bus or network io error

illegal_context 

given context is illegal

runtime_error 

runtime error

system_error 

system internal error

hardware_busy 

hardware is busy

argument_list_error 

input argument or parameter is invalid (alias for invalid_parameter

invalid_parameter 

input argument or parameter is invalid

file_error 

file access error

use_stream_transport 

datagram message size exceeds the allowable mtu (reserved)

dimension_error 

array dimension error

square_root_negative 

square root of a negative number

buffer_too_small 

supplied buffer is too small to handle the request

string_too_long 

supplied string is too long to buffer and cannot be truncated

ipx_socket_error 

ipx socket error (reserved)

net_read_error 

network read error

not_ready 

call to equipment module dispatch is not ready (internal, reserved)

invalid_transport_size 

total message size exceeds the configured allowable message size

log_negative 

log of a negative or zero number

device_not_connected 

requested device is not connected

unauthorised_action 

requested operation is not authorized

hardware_error 

hardware error

illegal_equipment_number 

requested device does not have a table entry (alias for illegal_device_number)

illegal_device_number 

requested device does not have a table entry

illegal_device 

requested device is illegal

illegal_property 

requested property is illegal

out_of_range 

given value is out of range

not_implemented 

requested operation has not been implemented

no_such_computer 

requested host computer does not exist

struct_sealed 

tagged structure has already been sealed (reserved)

syntax_error 

expression syntax error (unused)

no_such_file 

requested file does not exist

file_already_exists 

requested file already exists

no_file_space 

not enough capacity in pre-allocated random access file to complete the requested operation

link_not_open 

presistent link has timed out (alias for link_timeout)

link_timeout 

presistent link has timed out

remitted_data_lost 

returned only a portion of the requested data set (reserved)

end_of_file 

attempt to read past the end of a file (unused)

archive_busy 

archive operation is in progress

server_name_in_use 

device server name is already being used

no_such_column 

expected column not found in database

out_of_client_memory 

a client call could not allocate sufficient memory

mcast_access_required 

access requires CM_NETWORK which was not supplied! (contract coercion)

address_unresolved 

requested target address could not be resolved

invalid_property 

requested property is not properly formed

address_unknown 

requested target address could not be found

name_unknown 

requested name could not be found

invalid_keyword 

input globals keyword is invalid

invalid_link 

input link id is invalid

string_expected 

database file read encountered an end-of-line while expecting a string

out_of_local_memory 

a local call to allocated memory was not successful

out_of_shared_memory 

a call to obtain a shared-memory buffer was not successful

invalid_structure_tag 

the given structure tag is not in the structure registry

invalid_index 

the index given does not reference a table entry

illegal_equipment_name 

the equipment name given is not valid

link_error 

internal error processing data link (reserved)

code_failure 

internal failure due to unhandled exceptions, unavailable resource, OS failure, etc.

non_existent_server 

requested server does not exist

function_deprecated 

requested action or functionality has been deprecated

not_supported 

requested action or functionality not supported

illegal_character 

error parsing input

parsing_error 

error parsing input

illegal_operator 

input arithmetic or logical operator is not allowed

not_allowed 

requested operation is not allowed

illegal_read_write 

requested access is not allowed (typically CA_WRITE)

out_of_server_memory 

a server call could not allocate sufficient memory

database_not_loaded 

requested operation requires a database which has not been loaded

illegal_command 

requested command is illegal

resources_exhausted 

requested operation would exceed the configured capacity of an allocation table (clients, contracts, connections, etc.)

header_not_found 

expected csv file does not have a header

sedac_error 

sedac bus error

reacquire_address 

signal to reacquire a server's address from ENS (reserved, internal)

semaphore_error 

a semaphore or mutex could not be obtained or released

driver_not_installed 

request requires a hardware driver which is not installed

port_not_available 

request requires access to a port whichis not available

async_access_required 

access to selected property should be asynchronous (contract coercion)

semaphore_busy 

a semahpre or mutex could not be obtained within the requested time

non_existent_elem 

the requested equipment modules does not exist in the registry

non_existent_fec 

the requested FEC does not exist

non_existent_client 

(unused)

cannot_lock 

not able to obtain an access lock or lock resources

not_running 

the requested resource is not running

not_posted 

a dispatch routine did not post a reply

not_accepted 

the requested operation was refused

operation_timeout 

the requested operation did not complete within the time limit specified

illegal_protocol 

the incoming tine protocol is not recognized (reserved, internal)

gpib_error 

gpib bus error

rs232_error 

rs232 bus error

operation_busy 

the requested operation is busy and needs more time to complete

connection_timeout 

a synchronous link did not return within the time limit specified

illegal_mode 

the requested access mode is not valid

not_owner 

caller is not the owner of the requested resource

not_defined 

the requested operation has not yet been defined

net_write_error 

unable to send data on the network

invalid_data 

the input data are not valid

software_error 

general software error

access_denied 

call was refused by the security subsystem

tcp_not_supported 

an attempt to use TCP/IP access was made and is not supported on this host (reserved)

ipx_not_supported 

an attempt to use IPX access was made and is not supported on this host (reserved)

host_not_resolved 

the requested host could not be resolved

tcp_connect_error 

unable to connect to a TCP/IP socket (reserved)

tcp_socket_error 

general TCP/IP socket error (reserved)

configuration_error 

resource configuration error (e.g. redirection information)

invalid_return_code 

indicates a systematic error in processing the equipment dispatch handler (reserved)

link_blacklisted 

requested link parameters cannot succeed (due to initial return of non_existent_elem, address_unknown, etc.)

link_exists 

requested link already exists in the link table indicating a dependent link (reserved,internal)

max_alarms_exceeded 

attempt to add an alarm to the local alarm system whose capacity has been reached

not_exported 

(unused)

is_switching 

switching transition is in progress (unused)

at_limit 

setting/value is at a maximum or minimum or range exceeds storage (local history)

get_subscription_id 

used by access mode CM_NETWORK (reserved, internal)

renegotiate_contract 

used to repackage output data when few bytes are returned than requested (reserved, internal)

server_redirection 

used to supply redirection information (reserved, internal)

value_too_high 

returned value is too high

value_too_low 

returned value is too low

warn_too_high 

returned value is approaching too high

warn_too_low 

returned value is approaching too low

completion_waiting 

dependent link is waiting for parent to complete

cannot_select 

select() operation failed (reserved)

has_query_function 

query call to PROPERTIES or DEVICES has completed but indicated a hierachical preference (reserved)

not_signalled 

contract is waiting to call the equipment module dispatch routine (reserved, internal)

call_redirection 

nominal alias for server_redirection

udp_socket_error 

general UDP socket error (reserved)

mutex_error 

a mutex could not be obtained or released

data_not_local 

indicates that a device within a wildcard call needs to span multiple servers (reserved, internal)

name_already_exists 

a structure or bitfield field name already exists

already_assigned 

the requested resource has already been assigned

invalid_field 

a structure or bitfield field is invalid

mcast_init_error 

could not initialize a multicast socket (reserved)

invalid_mcast_group 

multicast group address is invalid

non_existent_function 

an equipment module's dispatch routine is not registered

property_is_mca 

requested property is a multi-channel array (contract coercion)

invalid_name 

input name is invalid

invalid_value 

input value is invalid

device_error 

requested device is in an error state

device_not_ready 

requested device is not ready

device_busy 

requested device is busy

invalid_interval 

requested polling interval is invalid (contract coercion)

notification_pending 

a link is pending notification (reserved, internal)

thread_error 

a thread operation failed

is_terminating 

the device server is terminating (reserved, internal)

name_server_unknown 

the equipment name server address is unknown (reserved, internal)

lock_required 

an access lock is required to process the operation

not_initialized 

server is not yet initialized

invalid_structure_size 

the input structure size does not match the size in the structure registry

canbus_error 

can bus error

profibus_error 

profibus error

data_stale 

contract's data are stale (reserved)

has_bitfield_tag 

reqested contract needs to request a bitfield (reserved, internal)

not_locked 

the requested resource does not have an access lock (reserved)

lock_expired 

the requested access lock has expired (reserved)

not_registered 

the requested property (e.g. SystemScheduleProperty()) has not been registered

non_existent_property 

the requested property does not exist

memory_overwrite 

a heap error within a dispatch routine has been detected

server_idle 

the server is in an idle state

not_applicable 

the requested opertion is not applicable in the current context

access_locked 

access temporarily suspended due to access lock

invalid_reference 

invalid data reference handle

has_structure_tag 

reqested contract needs to request a structure (reserved, internal)

warn_disk_space 

warn that disk space is low (local alarm system)

low_disk_space 

signal that disk space is very low (local alarm system)

information_static 

signal that static information is being 'polled' (contract coercion)

reset_mca_property 

signal to re-establish all mca single element links

record_too_long 

record length is too long to process within kernel

unix_socket_error 

an error condition on a unix (pipe) socket

pipe_error 

an error condition on a unix (pipe) socket

shm_error 

an error occured accessing shared memory

tcp_connection_closed 

tcp peer has closed the connection

service_unavailable 

requested service is unavailable

device_offline 

requested device is offline

out_of_sequence 

data value is out of sequence

invalid_datarequest 

requested data length or type is invalid (contract coercion)

property_is_mca_elevated 

requested property is a multi-channel array with elevated format

name_not_found 

named resource was not found in database

out_of_tolerance 

data out of tolerance

file_not_open 

read/write on file which is not open (re-introduce as some system servers were using it)

low_main_memory 

low available main memory detected

tcp_access_required 

access requires CM_CONNECT which was not supplied! (contract coercion)

Function Documentation

◆ GetErrorText()

TINE_EXPORT char* GetErrorText ( int  code,
char *  errstr,
int  length 
)

Returns the error text associated with an error code.

Parameters
codeis error code (system code or registered code) for which a descriptive message is desired.
errstris a string buffer to hold the error message.
lengthis the length of the buffer supplied as errstr
Returns
the string buffer supplied as errstr (for convenience)

◆ RegisterErrorCode()

TINE_EXPORT int RegisterErrorCode ( int  code,
char *  msgShort,
char *  msgLong 
)

Registers the error code given and associates with the given message strings.

Parameters
codeis the user-specified error code (512 or above) which can be returned from an equipment module or property handler.
msgShortis a short message string (32 characters or less) supplying a brief description of the error
msgLongis a long message string (128 characters or less) supplying a more descriptive explanation of the error.
Returns
0 upon success or a TINE error code (e.g. invalid_return_code) upon error.

Impressum   |   Imprint   |   Datenschutzerklaerung   |   Data Privacy Policy   |   Declaration of Accessibility   |   Erklaerung zur Barrierefreiheit
Generated for TINE API by  doxygen 1.5.8