SIF Error Codes


Defines

#define SIF_ERROR_NONE   0
 A status code indicating no error has been detected for the processing of the target file.
#define SIF_ERROR_MEM   1
 A status code indicating an error occurred while allocating or freeing memory.
#define SIF_ERROR_NULL_FP   2
 A status code indicating a file could not be processed because the file pointer is null. Admittedly, there is no way to store this in the sif_file struct passed since it is null. However, setting a static variable for the caller to check is under consideration for a future version.
#define SIF_ERROR_NULL_HDR   3
 A status code indicating a file could not be processed because the header pointer is null.
#define SIF_ERROR_INVALID_BN   4
 A status code indicating a block number passed to a sif-io function was invalid (i.e. negative or out-of-bounds).
#define SIF_ERROR_INVALID_TN   5
 A status code indicating a tile number passed to a sif-io function was invalid (i.e. negative or out-of-bounds).
#define SIF_ERROR_READ   6
 A status code indicating an error occurred when reading from the file.
#define SIF_ERROR_WRITE   7
 A status code indicating an error occurred when writing to the file.
#define SIF_ERROR_SEEK   8
 A status code indicating an error occurred when seeking in the file.
#define SIF_ERROR_TRUNCATE   9
 A status code indicating an error occurred when truncating the file.
#define SIF_ERROR_INVALID_FILE_MODE   10
 A status code indicating that the file mode chosen is invalid. This usually occurs when a file is opened for update that is read-only or a opened when the permissions do not permit reading.
#define SIF_ERROR_INCOMPATIBLE_VERSION   11
 A status code indicating that the currently loaded sif-io library is not capable of processing the version of a file. This is usually due to the fact that the file was written with a later version of the SIF format than the loaded library.
#define SIF_ERROR_META_DATA_KEY   12
 Returned when a call is made that expects a key to be present when the key cannot be found.
#define SIF_ERROR_META_DATA_VALUE   13
 Returned by sif_get_meta_data when the meta-data does not contain a null-terminated string.
#define SIF_ERROR_CANNOT_WRITE_VERSION   14
 Returned by sif_use_file_version when the library is not capable of writing the file in the requested version.
#define SIF_ERROR_INVALID_BAND   15
 Returned if a band argument passed is invalid.
#define SIF_ERROR_INVALID_COORD   16
 Returned if a coordinate argument (e.g. x or y) is invalid.
#define SIF_ERROR_INVALID_TILE_SIZE   17
 Returned if a tile size argument (e.g. tile_width or tile_height) is invalid.
#define SIF_ERROR_INVALID_REGION_SIZE   18
 Returned if a region size argument (e.g. width or height) is invalid.
#define SIF_ERROR_INVALID_BUFFER   19
 Returned if a tile size argument (e.g. width or height) is invalid.

Define Documentation

#define SIF_ERROR_CANNOT_WRITE_VERSION   14

Returned by sif_use_file_version when the library is not capable of writing the file in the requested version.

#define SIF_ERROR_INCOMPATIBLE_VERSION   11

A status code indicating that the currently loaded sif-io library is not capable of processing the version of a file. This is usually due to the fact that the file was written with a later version of the SIF format than the loaded library.

#define SIF_ERROR_INVALID_BAND   15

Returned if a band argument passed is invalid.

#define SIF_ERROR_INVALID_BN   4

A status code indicating a block number passed to a sif-io function was invalid (i.e. negative or out-of-bounds).

#define SIF_ERROR_INVALID_BUFFER   19

Returned if a tile size argument (e.g. width or height) is invalid.

#define SIF_ERROR_INVALID_COORD   16

Returned if a coordinate argument (e.g. x or y) is invalid.

#define SIF_ERROR_INVALID_FILE_MODE   10

A status code indicating that the file mode chosen is invalid. This usually occurs when a file is opened for update that is read-only or a opened when the permissions do not permit reading.

#define SIF_ERROR_INVALID_REGION_SIZE   18

Returned if a region size argument (e.g. width or height) is invalid.

#define SIF_ERROR_INVALID_TILE_SIZE   17

Returned if a tile size argument (e.g. tile_width or tile_height) is invalid.

#define SIF_ERROR_INVALID_TN   5

A status code indicating a tile number passed to a sif-io function was invalid (i.e. negative or out-of-bounds).

#define SIF_ERROR_MEM   1

A status code indicating an error occurred while allocating or freeing memory.

#define SIF_ERROR_META_DATA_KEY   12

Returned when a call is made that expects a key to be present when the key cannot be found.

#define SIF_ERROR_META_DATA_VALUE   13

Returned by sif_get_meta_data when the meta-data does not contain a null-terminated string.

#define SIF_ERROR_NONE   0

A status code indicating no error has been detected for the processing of the target file.

#define SIF_ERROR_NULL_FP   2

A status code indicating a file could not be processed because the file pointer is null. Admittedly, there is no way to store this in the sif_file struct passed since it is null. However, setting a static variable for the caller to check is under consideration for a future version.

#define SIF_ERROR_NULL_HDR   3

A status code indicating a file could not be processed because the header pointer is null.

#define SIF_ERROR_READ   6

A status code indicating an error occurred when reading from the file.

#define SIF_ERROR_SEEK   8

A status code indicating an error occurred when seeking in the file.

#define SIF_ERROR_TRUNCATE   9

A status code indicating an error occurred when truncating the file.

#define SIF_ERROR_WRITE   7

A status code indicating an error occurred when writing to the file.


Generated on Tue Dec 4 11:02:10 2007 for SIF by  doxygen 1.4.7