whole.h File Reference

Whole-file API driver functions. More...

Include dependency graph for whole.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
rs_result	rs_whole_run (rs_job_t *job, FILE *in_file, FILE *out_file, int inbuflen, int outbuflen)
	Run a job continuously, with input to/from the two specified files. More...

Detailed Description

Whole-file API driver functions.

Definition in file whole.h.

Function Documentation

rs_whole_run()

rs_result rs_whole_run	(	rs_job_t *	job,
		FILE *	in_file,
		FILE *	out_file,
		int	inbuflen,
		int	outbuflen
	)

Run a job continuously, with input to/from the two specified files.

The job should already be set up, and must be freed by the caller after return. If rs_inbuflen or rs_outbuflen are set, they will override the inbuflen and outbuflen arguments.

Parameters

job	- the job instance to run.
in_file	- input file, or NULL if there is no input.
out_file	- output file, or NULL if there is no output.
inbuflen	- recommended input buffer size to use.
outbuflen	- recommended output buffer size to use.

Returns

RS_DONE if the job completed, or otherwise an error result.

Definition at line 43 of file whole.c.