Error codes

Defines
#define	NTAR_SUCCESS   0
	The call to a function succeeded.
#define	NTAR_FAILURE   1
	The call to a function failed for some reason.
#define	NTAR_FAILURE_INVALID_ID   2
	The identifier of a block or an option is not valid or unknown.
#define	NTAR_FAILURE_FILENOTFOUND   3
	The call to ntar_open failed because the file does not exist.
#define	NTAR_FAILURE_FILEEXISTS   4
	The call to ntar_open failed because the file does exist.
#define	NTAR_FAILURE_CREATEFILEFAILED   5
	The call to ntar_open failed because it was not possible to create the file.
#define	NTAR_FAILURE_NOMEM   6
	No memory is available to allocate the internal structures.
#define	NTAR_FAILURE_SECTIONNOTCLOSED   7
	An attempt to close a file or create a new section has been made without closing the current opened section.
#define	NTAR_FAILURE_WRITEONREADFILE   8
	An attempt to write on a read file has been made.
#define	NTAR_FAILURE_IOWRITE   9
	A request to write to file failed.
#define	NTAR_FAILURE_BLOCKNOTCLOSED   10
	An attempt to close a section failed because the current block has not been closed.
#define	NTAR_FAILURE_IOREAD   11
	A request to read from a file failed.
#define	NTAR_FAILURE_EOF   12
	A request to read from a file failed.
#define	NTAR_FAILURE_INVALIDFILE   13
	The file opened for reading is not a valid NTAR file.
#define	NTAR_FAILURE_MALFORMED_BLOCK   14
	The opened block is not correct (e.g. the block length at the end has not the same value as the one at the beginning).
#define	NTAR_FAILURE_NOMOREBLOCKS   15
	There are no more blocks in the current section.
#define	NTAR_FAILURE_BLOCKDATAUNREAD   16
	An attempt to read a block option has been made without previously reading the block data.
#define	NTAR_FAILURE_SMALLBUFFER   17
	The buffer passed to a function is too small to retrieve some info.
#define	NTAR_FAILURE_BLOCKDATANOTSET   18
	The block data passed to create a new block are NULL.
#define	NTAR_FAILURE_DUPPTR   19
	An attempt to add the same option structure to a block has been made.
#define	NTAR_FAILURE_ASCIIDLFILE   20
	The file was probably downloaded in FTP ASCII mode or another ASCII transfer mode.
#define	NTAR_FAILURE_BLOCKTRAILERMISMATCH   21
	The trailer block size does not match the header one. The block has been closed, however.
#define	NTAR_FAILURE_ACCESSDENIED   22
	An attempt to open a protected file (either in read or write mode) has been been without the proper credentials.
#define	NTAR_FAILURE_BADFILEDESCRIPTOR   23
	An attempt to read or write to an invalid file descriptor has been made by the library.
#define	NTAR_FAILURE_INVALIDPARAMETER   24
	A wrong parameter has been passed to a CRT function.
#define	NTAR_FAILURE_TOOMANYOPENFILES   25
	Too many open files. No more file descriptors are available, so no more files can be opened.
#define	NTAR_FAILURE_DISKFULL   26
	The disk is full, so any further writes to the file are not allowed.
#define	NTAR_FAILURE_UNKNOWNERRNO   27
	A CRT error has been detected by the library, but the corresponding errno code is unknown.

---

Define Documentation

#define NTAR_FAILURE   1

The call to a function failed for some reason.

#define NTAR_FAILURE_ACCESSDENIED   22

An attempt to open a protected file (either in read or write mode) has been been without the proper credentials.

#define NTAR_FAILURE_ASCIIDLFILE   20

The file was probably downloaded in FTP ASCII mode or another ASCII transfer mode.

#define NTAR_FAILURE_BADFILEDESCRIPTOR   23

An attempt to read or write to an invalid file descriptor has been made by the library.

#define NTAR_FAILURE_BLOCKDATANOTSET   18

The block data passed to create a new block are NULL.

#define NTAR_FAILURE_BLOCKDATAUNREAD   16

An attempt to read a block option has been made without previously reading the block data.

#define NTAR_FAILURE_BLOCKNOTCLOSED   10

An attempt to close a section failed because the current block has not been closed.

#define NTAR_FAILURE_BLOCKTRAILERMISMATCH   21

The trailer block size does not match the header one. The block has been closed, however.

#define NTAR_FAILURE_CREATEFILEFAILED   5

The call to ntar_open failed because it was not possible to create the file.

#define NTAR_FAILURE_DISKFULL   26

The disk is full, so any further writes to the file are not allowed.

#define NTAR_FAILURE_DUPPTR   19

An attempt to add the same option structure to a block has been made.

#define NTAR_FAILURE_EOF   12

A request to read from a file failed.

#define NTAR_FAILURE_FILEEXISTS   4

The call to ntar_open failed because the file does exist.

#define NTAR_FAILURE_FILENOTFOUND   3

The call to ntar_open failed because the file does not exist.

#define NTAR_FAILURE_INVALID_ID   2

The identifier of a block or an option is not valid or unknown.

#define NTAR_FAILURE_INVALIDFILE   13

The file opened for reading is not a valid NTAR file.

#define NTAR_FAILURE_INVALIDPARAMETER   24

A wrong parameter has been passed to a CRT function.

#define NTAR_FAILURE_IOREAD   11

A request to read from a file failed.

#define NTAR_FAILURE_IOWRITE   9

A request to write to file failed.

#define NTAR_FAILURE_MALFORMED_BLOCK   14

The opened block is not correct (e.g. the block length at the end has not the same value as the one at the beginning).

#define NTAR_FAILURE_NOMEM   6

No memory is available to allocate the internal structures.

#define NTAR_FAILURE_NOMOREBLOCKS   15

There are no more blocks in the current section.

#define NTAR_FAILURE_SECTIONNOTCLOSED   7

An attempt to close a file or create a new section has been made without closing the current opened section.

#define NTAR_FAILURE_SMALLBUFFER   17

The buffer passed to a function is too small to retrieve some info.

#define NTAR_FAILURE_TOOMANYOPENFILES   25

Too many open files. No more file descriptors are available, so no more files can be opened.

#define NTAR_FAILURE_UNKNOWNERRNO   27

A CRT error has been detected by the library, but the corresponding errno code is unknown.

#define NTAR_FAILURE_WRITEONREADFILE   8

An attempt to write on a read file has been made.

#define NTAR_SUCCESS   0

The call to a function succeeded.

---

NTAR documentation. Copyright (c) 2004 - 2005 Condor Engineering, Inc. All rights reserved.