libics: Error codes

libics v.1.6.6 Online Documentation. ©2000-2010 by Cris Luengo and others.

# Error codes returned by the library functions

`Ics_Error` is an `enum` that represents all the error codes returned by most of the functions in this library. They are sorted in alphabetical order, except for the first three values, which are special.

### IcsErr_Ok

No error occurred. Its numerical value is `0`, so you can test with "`if` (`error`) ..."

### IcsErr_FSizeConflict

Unexpected data size (non fatal error).

### IcsErr_OutputNotFilled

The output buffer could not be completely filled (non fatal error). Returned by data reading functions if the buffer given was larger than the amount of data read.

### IcsErr_Alloc

Memory allocation error.

### IcsErr_BitsVsSizeConfl

Image size conflicts with bits per element.

### IcsErr_BlockNotAllowed

It is not possible to read COMPRESS-compressed data in blocks.

### IcsErr_BufferTooSmall

The buffer was too small to hold the given ROI.

### IcsErr_CompressionProblem

Some error occurred during compression.

### IcsErr_CorruptedStream

The compressed input stream is corrupted.

### IcsErr_DecompressionProblem

Some error occurred during decompression.

### IcsErr_DuplicateData

The `Data` field has already been set.

### IcsErr_EmptyField

Empty field.

### IcsErr_EndOfHistory

All history lines have already been returned.

### IcsErr_EndOfStream

Unexpected end of stream.

### IcsErr_FailWriteLine

Failed to write a line in .ics file.

### IcsErr_FCloseIcs

File close error on .ics file.

### IcsErr_FCloseIds

File close error on data file.

### IcsErr_FCopyIds

Failed to copy image data from temporary file on .ics file opened for updating.

### IcsErr_FOpenIcs

File open error on .ics file.

### IcsErr_FOpenIds

File open error on data file.

### IcsErr_FReadIcs

File read error on .ics file.

### IcsErr_FReadIds

File read error on data file.

### IcsErr_FTempMoveIcs

Failed to rename .ics file opened for updating.

### IcsErr_FWriteIcs

File write error on .ics file.

### IcsErr_FWriteIds

File write error on data file.

### IcsErr_IllegalROI

The given ROI extends outside the image.

### IcsErr_IllIcsToken

Illegal ICS token detected.

### IcsErr_IllParameter

A function parameter has a value that is not legal or does not match with a value previously given.

### IcsErr_LineOverflow

Line overflow writing .ics file.

### IcsErr_MissBits

Missing "bits" element in ICS file.

### IcsErr_MissCat

Missing main category.

### IcsErr_MissingData

The `Data` field is not yet been set.

### IcsErr_MissLayoutSubCat

Missing layout subcategory.

### IcsErr_MissParamSubCat

Missing parameter subcategory.

### IcsErr_MissRepresSubCat

Missing representation subcategory.

### IcsErr_MissSensorSubCat

Missing sensor subcategory.

### IcsErr_MissSensorSubSubCat

Missing sensor subsubcategory.

### IcsErr_MissSubCat

Missing sub category.

### IcsErr_NoLayout

Layout parameters missing or not defined.

### IcsErr_NoScilType

The function `IcsGuessScilType` could not create a SCIL_TYPE string for the image as currently defined.

### IcsErr_NotIcsFile

Not an ICS file, or unrecognized ICS version.

### IcsErr_NotValidAction

The function won't work on the ICS given. This is returned by the top-level functions when a 'Set' function is called on an ICS open for reading, or a 'Get' function is called on an ICS open for writing.

### IcsErr_TooManyChans

Too many channels specified.

### IcsErr_TooManyDims

Too many dimensions specified.

### IcsErr_TooManyDetectors

Too many detectors specified.

### IcsErr_UnknownCompression

Unknown compression type.

### IcsErr_UnknownDataType

The data type is not recognized.

### IcsErr_WrongZlibVersion

libics is linking to a different version of zlib than used during compilation.