This documentation describes the Prokee module interface.
Library Functions (Exported Pointers Version):
Basic Functions:
deflate
int deflate(z_streamp strm,int flush)
inflate
int inflate(z_streamp strm,int flush)
deflateSetDictionary
int deflateSetDictionary(z_streamp strm,const Bytef *dictionary,uInt dictLength)
deflateCopy
int deflateCopy(z_streamp dest,z_streamp source)
deflateParams
int deflateParams(z_streamp strm,int level,int strategy)
deflateTune
int deflateTune(z_streamp strm,int good_length,int max_lazy,int nice_length,int max_chain)
deflateBound
uLong deflateBound(z_streamp strm,uLong sourceLen)
deflatePending
int deflatePending(z_streamp strm,unsigned int *pending,int *bits)
deflatePrime
int deflatePrime(z_streamp strm,int bits,int value)
inflateSetDictionary
int inflateSetDictionary(z_streamp strm,const Bytef *dictionary,uInt dictLength)
inflateCopy
int inflateCopy(z_streamp dest,z_streamp source)
inflatePrime
int inflatePrime(z_streamp strm,int bits,int value)
inflateBack
int inflateBack(z_streamp strm,in_func in,void *in_desc,out_func out,void *out_desc)
Utility Functions:
compress
int compress(Bytef *dest,uLongf *destLen,const Bytef *source,uLong sourceLen)
compress2
int compress2(Bytef *dest,uLongf *destLen,const Bytef *source,uLong sourceLen,int level)
uncompress
int uncompress(Bytef *dest,uLongf *destLen,const Bytef *source,uLong sourceLen)
uncompress2
int uncompress2(Bytef *dest,uLongf *destLen,const Bytef *source,uLong *sourceLen)
GZIP File Access Functions:
gzopen
gzFile gzopen(const char *path,const char *mode)
gzdopen
gzFile gzdopen(int fd,const char *mode)
gzbuffer
int gzbuffer(gzFile file,unsigned int size)
gzsetparams
int gzsetparams(gzFile file,int level,int strategy)
gzread
int gzread(gzFile file,voidp buf,unsigned int len)
gzfread
z_size_t gzfread(voidp buf,z_size_t size,z_size_t nitems,gzFile file)
gzwrite
int gzwrite(gzFile file,voidpc buf,unsigned int len)
gzfwrite
z_size_t gzfwrite(voidpc buf,z_size_t size,z_size_t nitems,gzFile file)
gzprintf
int gzprintf(gzFile file,const char *format,... )
gzputs
int gzputs(gzFile file,const char *s)
gzgets
char *gzgets(gzFile file,char *buf,int len)
gzputc
int gzputc(gzFile file,int c)
gzungetc
int gzungetc(int c,gzFile file)
gzflush
int gzflush(gzFile file,int flush)
gzseek
z_off_t gzseek(gzFile file,z_off_t offset,int whence)
gztell
z_off_t gztell(gzFile file)
gzeof
int gzeof(gzFile file)
gzerror
const char *gzerror(gzFile file,int *errnum)
Checksum Functions:
adler32
uLong adler32(uLong adler,const Bytef *buf,uInt len)
adler32_z
uLong adler32_z(uLong adler,const Bytef *buf,z_size_t len)
adler32_combine
uLong adler32_combine(uLong adler1,uLong adler2,z_off_t len2)
crc32
uLong crc32(uLong crc,const Bytef *buf,uInt len)
crc32_z
uLong crc32_z(uLong crc,const Bytef *buf,z_size_t len)
crc32_combine
uLong crc32_combine(uLong crc1,uLong crc2,z_off_t len2)
Uncategorized Functions:
deflateInit_
int deflateInit_(z_streamp strm,int level,const char *version,int stream_size)
inflateInit_
int inflateInit_(z_streamp strm,const char *version,int stream_size)
deflateInit2_
int deflateInit2_(z_streamp strm,int level,int method,int windowBits,int memLevel,int strategy,const char *version,int stream_size)
inflateInit2_
int inflateInit2_(z_streamp strm,int windowBits,const char *version,int stream_size)
inflateBackInit_
int inflateBackInit_(z_streamp strm,int windowBits,unsigned char *window,const char *version,int stream_size)
Undocumented Functions:
Motivation
Library Functions (Exported Pointers Version)
zlibVersion
See zlib.h.
Signature:
const char *zlibVersion()
deflate
See zlib.h.
Signature:
int deflate(z_streamp strm,int flush)
Parameters:
deflateEnd
See zlib.h.
Signature:
int deflateEnd(z_streamp strm)
Parameters:
inflate
See zlib.h.
Signature:
int inflate(z_streamp strm,int flush)
Parameters:
inflateEnd
See zlib.h.
Signature:
int inflateEnd(z_streamp strm)
Parameters:
deflateSetDictionary
See zlib.h.
Signature:
int deflateSetDictionary(z_streamp strm,const Bytef *dictionary,uInt dictLength)
Parameters:
| z_streamp | strm | | |
| const Bytef * | dictionary | | |
| uInt | dictLength | | |
deflateGetDictionary
See zlib.h.
Signature:
int deflateGetDictionary(z_streamp strm,Bytef *dictionary,uInt *dictLength)
Parameters:
| z_streamp | strm | | |
| Bytef * | dictionary | | |
| uInt * | dictLength | | |
deflateCopy
See zlib.h.
Signature:
int deflateCopy(z_streamp dest,z_streamp source)
Parameters:
| z_streamp | dest | | |
| z_streamp | source | | |
deflateReset
See zlib.h.
Signature:
int deflateReset(z_streamp strm)
Parameters:
deflateParams
See zlib.h.
Signature:
int deflateParams(z_streamp strm,int level,int strategy)
Parameters:
| z_streamp | strm | | |
| int | level | | |
| int | strategy | | |
deflateTune
See zlib.h.
Signature:
int deflateTune(z_streamp strm,int good_length,int max_lazy,int nice_length,int max_chain)
Parameters:
| z_streamp | strm | | |
| int | good_length | | |
| int | max_lazy | | |
| int | nice_length | | |
| int | max_chain | | |
deflateBound
See zlib.h.
Signature:
uLong deflateBound(z_streamp strm,uLong sourceLen)
Parameters:
| z_streamp | strm | | |
| uLong | sourceLen | | |
deflatePending
See zlib.h.
Signature:
int deflatePending(z_streamp strm,unsigned int *pending,int *bits)
Parameters:
| z_streamp | strm | | |
| unsigned int * | pending | | |
| int * | bits | | |
deflatePrime
See zlib.h.
Signature:
int deflatePrime(z_streamp strm,int bits,int value)
Parameters:
| z_streamp | strm | | |
| int | bits | | |
| int | value | | |
inflateSetDictionary
See zlib.h.
Signature:
int inflateSetDictionary(z_streamp strm,const Bytef *dictionary,uInt dictLength)
Parameters:
| z_streamp | strm | | |
| const Bytef * | dictionary | | |
| uInt | dictLength | | |
inflateGetDictionary
See zlib.h.
Signature:
int inflateGetDictionary(z_streamp strm,Bytef *dictionary,uInt *dictLength)
Parameters:
| z_streamp | strm | | |
| Bytef * | dictionary | | |
| uInt * | dictLength | | |
inflateSync
See zlib.h.
Signature:
int inflateSync(z_streamp strm)
Parameters:
inflateCopy
See zlib.h.
Signature:
int inflateCopy(z_streamp dest,z_streamp source)
Parameters:
| z_streamp | dest | | |
| z_streamp | source | | |
inflateReset
See zlib.h.
Signature:
int inflateReset(z_streamp strm)
Parameters:
inflateReset2
See zlib.h.
Signature:
int inflateReset2(z_streamp strm,int windowBits)
Parameters:
| z_streamp | strm | | |
| int | windowBits | | |
inflatePrime
See zlib.h.
Signature:
int inflatePrime(z_streamp strm,int bits,int value)
Parameters:
| z_streamp | strm | | |
| int | bits | | |
| int | value | | |
inflateMark
See zlib.h.
Signature:
long int inflateMark(z_streamp strm)
Parameters:
inflateBack
See zlib.h.
Signature:
int inflateBack(z_streamp strm,in_func in,void *in_desc,out_func out,void *out_desc)
Parameters:
| z_streamp | strm | | |
| in_func | in | | |
| void * | in_desc | | |
| out_func | out | | |
| void * | out_desc | | |
inflateBackEnd
See zlib.h.
Signature:
int inflateBackEnd(z_streamp strm)
Parameters:
zlibCompileFlags
See zlib.h.
Signature:
uLong zlibCompileFlags()
compress
See zlib.h.
Signature:
int compress(Bytef *dest,uLongf *destLen,const Bytef *source,uLong sourceLen)
Parameters:
| Bytef * | dest | | |
| uLongf * | destLen | | |
| const Bytef * | source | | |
| uLong | sourceLen | | |
compress2
See zlib.h.
Signature:
int compress2(Bytef *dest,uLongf *destLen,const Bytef *source,uLong sourceLen,int level)
Parameters:
| Bytef * | dest | | |
| uLongf * | destLen | | |
| const Bytef * | source | | |
| uLong | sourceLen | | |
| int | level | | |
compressBound
See zlib.h.
Signature:
uLong compressBound(uLong sourceLen)
Parameters:
uncompress
See zlib.h.
Signature:
int uncompress(Bytef *dest,uLongf *destLen,const Bytef *source,uLong sourceLen)
Parameters:
| Bytef * | dest | | |
| uLongf * | destLen | | |
| const Bytef * | source | | |
| uLong | sourceLen | | |
uncompress2
See zlib.h.
Signature:
int uncompress2(Bytef *dest,uLongf *destLen,const Bytef *source,uLong *sourceLen)
Parameters:
| Bytef * | dest | | |
| uLongf * | destLen | | |
| const Bytef * | source | | |
| uLong * | sourceLen | | |
gzopen
See zlib.h.
Signature:
gzFile gzopen(const char *path,const char *mode)
Parameters:
| const char * | path | | |
| const char * | mode | | |
gzdopen
See zlib.h.
Signature:
gzFile gzdopen(int fd,const char *mode)
Parameters:
gzbuffer
See zlib.h.
Signature:
int gzbuffer(gzFile file,unsigned int size)
Parameters:
| gzFile | file | | |
| unsigned int | size | | |
gzsetparams
See zlib.h.
Signature:
int gzsetparams(gzFile file,int level,int strategy)
Parameters:
| gzFile | file | | |
| int | level | | |
| int | strategy | | |
gzread
See zlib.h.
Signature:
int gzread(gzFile file,voidp buf,unsigned int len)
Parameters:
| gzFile | file | | |
| voidp | buf | | |
| unsigned int | len | | |
gzfread
See zlib.h.
Signature:
z_size_t gzfread(voidp buf,z_size_t size,z_size_t nitems,gzFile file)
Parameters:
| voidp | buf | | |
| z_size_t | size | | |
| z_size_t | nitems | | |
| gzFile | file | | |
gzwrite
See zlib.h.
Signature:
int gzwrite(gzFile file,voidpc buf,unsigned int len)
Parameters:
| gzFile | file | | |
| voidpc | buf | | |
| unsigned int | len | | |
gzfwrite
See zlib.h.
Signature:
z_size_t gzfwrite(voidpc buf,z_size_t size,z_size_t nitems,gzFile file)
Parameters:
| voidpc | buf | | |
| z_size_t | size | | |
| z_size_t | nitems | | |
| gzFile | file | | |
gzprintf
See zlib.h.
Signature:
int gzprintf(gzFile file,const char *format,... )
Parameters:
| gzFile | file | | |
| const char * | format | | |
| ... | | | |
gzputs
See zlib.h.
Signature:
int gzputs(gzFile file,const char *s)
Parameters:
| gzFile | file | | |
| const char * | s | | |
gzgets
See zlib.h.
Signature:
char *gzgets(gzFile file,char *buf,int len)
Parameters:
| gzFile | file | | |
| char * | buf | | |
| int | len | | |
gzputc
See zlib.h.
Signature:
int gzputc(gzFile file,int c)
Parameters:
gzungetc
See zlib.h.
Signature:
int gzungetc(int c,gzFile file)
Parameters:
gzflush
See zlib.h.
Signature:
int gzflush(gzFile file,int flush)
Parameters:
gzseek
See zlib.h.
Signature:
z_off_t gzseek(gzFile file,z_off_t offset,int whence)
Parameters:
| gzFile | file | | |
| z_off_t | offset | | |
| int | whence | | |
gzrewind
See zlib.h.
Signature:
int gzrewind(gzFile file)
Parameters:
gztell
See zlib.h.
Signature:
z_off_t gztell(gzFile file)
Parameters:
gzoffset
See zlib.h.
Signature:
z_off_t gzoffset(gzFile file)
Parameters:
gzeof
See zlib.h.
Signature:
int gzeof(gzFile file)
Parameters:
gzdirect
See zlib.h.
Signature:
int gzdirect(gzFile file)
Parameters:
gzclose
See zlib.h.
Signature:
int gzclose(gzFile file)
Parameters:
gzclose_r
See zlib.h.
Signature:
int gzclose_r(gzFile file)
Parameters:
gzclose_w
See zlib.h.
Signature:
int gzclose_w(gzFile file)
Parameters:
gzerror
See zlib.h.
Signature:
const char *gzerror(gzFile file,int *errnum)
Parameters:
gzclearerr
See zlib.h.
Signature:
void gzclearerr(gzFile file)
Parameters:
adler32
See zlib.h.
Signature:
uLong adler32(uLong adler,const Bytef *buf,uInt len)
Parameters:
| uLong | adler | | |
| const Bytef * | buf | | |
| uInt | len | | |
adler32_z
See zlib.h.
Signature:
uLong adler32_z(uLong adler,const Bytef *buf,z_size_t len)
Parameters:
| uLong | adler | | |
| const Bytef * | buf | | |
| z_size_t | len | | |
adler32_combine
See zlib.h.
Signature:
uLong adler32_combine(uLong adler1,uLong adler2,z_off_t len2)
Parameters:
| uLong | adler1 | | |
| uLong | adler2 | | |
| z_off_t | len2 | | |
crc32
See zlib.h.
Signature:
uLong crc32(uLong crc,const Bytef *buf,uInt len)
Parameters:
| uLong | crc | | |
| const Bytef * | buf | | |
| uInt | len | | |
crc32_z
See zlib.h.
Signature:
uLong crc32_z(uLong crc,const Bytef *buf,z_size_t len)
Parameters:
| uLong | crc | | |
| const Bytef * | buf | | |
| z_size_t | len | | |
crc32_combine
See zlib.h.
Signature:
uLong crc32_combine(uLong crc1,uLong crc2,z_off_t len2)
Parameters:
| uLong | crc1 | | |
| uLong | crc2 | | |
| z_off_t | len2 | | |
deflateInit_
See zlib.h.
Signature:
int deflateInit_(z_streamp strm,int level,const char *version,int stream_size)
Parameters:
| z_streamp | strm | | |
| int | level | | |
| const char * | version | | |
| int | stream_size | | |
inflateInit_
See zlib.h.
Signature:
int inflateInit_(z_streamp strm,const char *version,int stream_size)
Parameters:
| z_streamp | strm | | |
| const char * | version | | |
| int | stream_size | | |
deflateInit2_
See zlib.h.
Signature:
int deflateInit2_(z_streamp strm,int level,int method,int windowBits,int memLevel,int strategy,const char *version,int stream_size)
Parameters:
| z_streamp | strm | | |
| int | level | | |
| int | method | | |
| int | windowBits | | |
| int | memLevel | | |
| int | strategy | | |
| const char * | version | | |
| int | stream_size | | |
inflateInit2_
See zlib.h.
Signature:
int inflateInit2_(z_streamp strm,int windowBits,const char *version,int stream_size)
Parameters:
| z_streamp | strm | | |
| int | windowBits | | |
| const char * | version | | |
| int | stream_size | | |
inflateBackInit_
See zlib.h.
Signature:
int inflateBackInit_(z_streamp strm,int windowBits,unsigned char *window,const char *version,int stream_size)
Parameters:
| z_streamp | strm | | |
| int | windowBits | | |
| unsigned char * | window | | |
| const char * | version | | |
| int | stream_size | | |
gzgetc_
See zlib.h.
Signature:
int gzgetc_(gzFile file)
Parameters:
inflateUndermine
See zlib.h.
Signature:
int inflateUndermine(z_streamp a,int b)
Parameters:
inflateValidate
See zlib.h.
Signature:
int inflateValidate(z_streamp a,int b)
Parameters: