SprStreamOpenInfo Struct Reference

Collaboration diagram for SprStreamOpenInfo:

Data Fields
char *	cpy_fname
	Working copy (this can be modified). More...
const char *	err
	Error message (set this when something goes wrong). More...
char *	epos
SprStream *	fd
	Stream pointer to push the coder on. More...
SprKeySet *	keys
	The current keyset. More...
SprMsgId *	routine
	Identify the calling routine. More...
char *	fname
	Best guess for a suitable file name. More...
unsigned int	fname_maxlen
unsigned int	flags
	Flags given when opening the file. More...

Detailed Description

Information passed to the routines that provide (new) coders, protocols or header formats. The information mainly serves for error reporting (err and epos) or other messages (routine).

The fd, fname, keys, and flags fields are needed when opening streams (protocol) or when pushing filters (coders).

Field Documentation

char* SprStreamOpenInfo::cpy_fname

Working copy (this can be modified).

const char* SprStreamOpenInfo::err

Error message (set this when something goes wrong).

char* SprStreamOpenInfo::epos

Position in cpy_fname where the error occured (do not set if the position is irrelevant)

SprStream* SprStreamOpenInfo::fd

Stream pointer to push the coder on.

SprKeySet* SprStreamOpenInfo::keys

The current keyset.

SprMsgId* SprStreamOpenInfo::routine

Identify the calling routine.

char* SprStreamOpenInfo::fname

Best guess for a suitable file name.

may change during the process but at the given location there will always be an valid and informative name.

unsigned int SprStreamOpenInfo::fname_maxlen

Routines may change the name if and only if it fits in the allotted space (including the final '\0').

unsigned int SprStreamOpenInfo::flags

Flags given when opening the file.