libstdf.h File Reference


Detailed Description

Top level include and the main stdf structure definition.

Go to the source code of this file.

Typedefs

typedef void stdf_file

Enumerations

enum  stdf_format {
  STDF_FORMAT_REG = 0x0,
  STDF_FORMAT_ZIP = 0x1,
  STDF_FORMAT_GZIP = 0x2,
  STDF_FORMAT_BZIP2 = 0x3,
  STDF_FORMAT_LZW = 0x4
}
enum  stdf_initial_options {
  STDF_OPTS_DEFAULT = 0x000,
  STDF_OPTS_FORCE = 0x001,
  STDF_OPTS_FORCE_V3 = 0x002,
  STDF_OPTS_FORCE_V4 = 0x004,
  STDF_OPTS_ZIP = 0x008,
  STDF_OPTS_GZIP = 0x010,
  STDF_OPTS_BZIP2 = 0x020,
  STDF_OPTS_LZW = 0x040,
  STDF_OPTS_READ = 0x080,
  STDF_OPTS_WRITE = 0x100,
  STDF_OPTS_CREATE = 0x200
}
enum  stdf_runtime_settings {
  STDF_SETTING_WRITE_SIZE = 0x001,
  STDF_SETTING_VERSION = 0x002,
  STDF_SETTING_BYTE_ORDER = 0x003
}


Enumeration Type Documentation

enum stdf_format
 

Compressed file format

Enumerator:
STDF_FORMAT_REG  Regular file
STDF_FORMAT_ZIP  Zipped file
STDF_FORMAT_GZIP  gzipped file
STDF_FORMAT_BZIP2  bzipped file
STDF_FORMAT_LZW  LZW compressed file

enum stdf_initial_options
 

Misc options to control libstdf behavior

Enumerator:
STDF_OPTS_DEFAULT  Default options
STDF_OPTS_FORCE  Force reading even if some sanity checks fail
STDF_OPTS_FORCE_V3  Force STDFv3 behavior
STDF_OPTS_FORCE_V4  Force STDFv4 behavior
STDF_OPTS_ZIP  File is compressed with zip
STDF_OPTS_GZIP  File is compressed with gzip
STDF_OPTS_BZIP2  File is compressed with bzip2
STDF_OPTS_LZW  File is compressed with lzw
STDF_OPTS_READ  Allow reading from file
STDF_OPTS_WRITE  Allow writing to file
STDF_OPTS_CREATE  Create file from scratch

enum stdf_runtime_settings
 

Enumerator:
STDF_SETTING_WRITE_SIZE  Set the output blocksize for writing
STDF_SETTING_VERSION  Query the STDF spec version
STDF_SETTING_BYTE_ORDER  Query the byte order


Generated on Thu Jun 8 14:05:35 2006 for libstdf by  doxygen 1.4.6