Definition of the function code dependent structures for FAVE. More...

Data Structures
struct	FaveOpn
	FAVE parameter structure for function code FAVE_FUNC_OPN. More...

struct	FaveRun
	FAVE Run structure. More...

struct	FaveCls
	FAVE Close structure. More...

union	FavePar
	FAVE Union of function structures. More...

Typedefs
typedef struct FaveOpn	TsFaveOpn
	FAVE parameter structure for function code FAVE_FUNC_OPN.

typedef struct FaveRun	TsFaveRun
	FAVE Run structure.

typedef struct FaveCls	TsFaveCls
	FAVE Close structure.

typedef union FavePar	TuFavePar
	FAVE Union of function structures.

Detailed Description

Definition of the function code dependent structures for FAVE.

Typedef Documentation

◆ TsFaveCls

typedef struct FaveCls TsFaveCls

FAVE Close structure.

This structure is used when the exit function is called with the function code FAVE_FUNC_CLS. It is always called after data processing is finished, no matter if there was error or not.

The only member pair is a 4096 bytes buffer for an error message. The corresponding length must be set to the length of the error message.

◆ TsFaveOpn

typedef struct FaveOpn TsFaveOpn

FAVE parameter structure for function code FAVE_FUNC_OPN.

This structure is used when the exit function is called with the function code FAVE_FUNC_OPN.

The first member contains flags that can be set in both directions. If the exit is opened for output data, the flag bit FAVE_FLAG_WRITE is set. If it is not set, the exit is opened for reading input data. See the flags section for further flags.

The next pair of members contains the length and a pointer to the parameter string interpreted by the service provider.

The last member pair is a buffer of 4096 bytes for an error message. The corresponding length must be set to the length of the error message.

◆ TsFaveRun

typedef struct FaveRun TsFaveRun

FAVE Run structure.

This structure is used when the exit function is called with the function code FAVE_FUNC_RUN. It is called for each read/written data segment.

The exit drivers passes the length and a pointer to the input data of the current data segment as the first pair of members of the structure.

The last member pair is a 4096 bytes buffer for an error message. The corresponding length must be set to the length of the error message.

◆ TuFavePar

typedef union FavePar TuFavePar

FAVE Union of function structures.

This union must be used to access structure fields depending on the function code that was passed to the exit function. Only the member that corresponds to the function code may be accessed. Failing to do so results in undefined behavior!