Main Page   Alphabetical List   Data Structures   File List   Data Fields   Globals  

types.h File Reference

Type definitions. More...

Go to the source code of this file.

Access mode macros

#define CX_IS_MODE_RAW(mode)   (((mode) & CX_MODE_RAW) == CX_MODE_RAW)
#define CX_IS_MODE_READ_WRITE(mode)   (((mode) & CX_MODE_READ_WRITE) == CX_MODE_READ_WRITE)
#define CX_IS_MODE_READ_ONLY(mode)   (((mode) & CX_MODE_READ_ONLY) == CX_MODE_READ_ONLY)

Enumerations

enum  CxStatus {
  CX_SUCCESS, CX_NOT_SUPPORTED, CX_INVALID_FORMAT, CX_ERROR,
  CX_FILE_NOT_FOUND, CX_READ_ONLY, CX_INVALID_VERSION, CX_EOF,
  CX_CORRUPT
}
 A status result. More...

enum  CxAccessMode { CX_MODE_RAW = 0x01, CX_MODE_READ_WRITE = 0x02, CX_MODE_READ_ONLY = 0x04, CX_MODE_ERROR = 0xFF }
 The access mode used when opening a file or archive. More...

enum  CxArchiveType { CX_ARCHIVE_SINGLE, CX_ARCHIVE_MULTI, CX_ARCHIVE_UNKNOWN }
 An archive type. More...


Detailed Description

Type definitions.

Copyright:
(C) 2001-2003 The GNUpdate Project.
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.

You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


Define Documentation

#define CX_IS_MODE_RAW mode       (((mode) & CX_MODE_RAW) == CX_MODE_RAW)
 

#define CX_IS_MODE_READ_ONLY mode       (((mode) & CX_MODE_READ_ONLY) == CX_MODE_READ_ONLY)
 

#define CX_IS_MODE_READ_WRITE mode       (((mode) & CX_MODE_READ_WRITE) == CX_MODE_READ_WRITE)
 


Enumeration Type Documentation

enum CxAccessMode
 

The access mode used when opening a file or archive.

Enumeration values:
CX_MODE_RAW  Don't handle compression/decompression with the file.
CX_MODE_READ_WRITE  Allows reading and writing to files.
CX_MODE_READ_ONLY  Allows reading, but not writing, of files.
CX_MODE_ERROR  An error has occurred.

Most likely, the specified file is NULL.

enum CxArchiveType
 

An archive type.

Enumeration values:
CX_ARCHIVE_SINGLE  Single-file archives.
CX_ARCHIVE_MULTI  Multi-file archives.
CX_ARCHIVE_UNKNOWN  Unknown archive type (usually an error).

enum CxStatus
 

A status result.

Enumeration values:
CX_SUCCESS  Operation completed successfully.
CX_NOT_SUPPORTED  The feature is not supported in that module.
CX_INVALID_FORMAT  Invalid file format.
CX_ERROR  Fatal error.
CX_FILE_NOT_FOUND  File not found.
CX_READ_ONLY  The file is read-only.
CX_INVALID_VERSION  Invalid or unsupported archive version.
CX_EOF  End of file.
CX_CORRUPT  Corruption.


Generated on Wed Mar 5 20:47:44 2003 for libcomprex by doxygen1.2.18-20021020