1\" Generated by c2man from bl_fastq_write.c
2.TH bl_fastq_write 3
3
4.SH LIBRARY
5\" Indicate #includes, library name, -L and -l flags
6.nf
7.na
8#include <biolibc/fastq.h>
9-lbiolibc -lxtend
10.ad
11.fi
12
13\" Convention:
14\" Underline anything that is typed verbatim - commands, etc.
15.SH SYNOPSIS
16.PP
17int     bl_fastq_write(FILE *fastq_stream, bl_fastq_t *record,
18size_t max_line_len)
19
20.SH ARGUMENTS
21.nf
22.na
23fastq_stream    FILE stream to which data are written
24record          Pointer to a bl_fastq_t structure to be written
25max_line_len    Maximum length of a sequence line in output
26.ad
27.fi
28
29.SH DESCRIPTION
30
31Write a FASTQ record to the specified FILE stream, writing at most
32max_line_len sequence characters per line.  The special value
33BL_FASTQ_LINE_UNLIMITED indicates no line length limit.
34
35.SH RETURN VALUES
36
37BL_WRITE_OK upon success, BL_WRITE_FAILURE if a write error occurs.
38
39.SH EXAMPLES
40.nf
41.na
42
43bl_fastq_t  rec = BL_FASTQ_INIT;
44
45while ( bl_fastq_read(stdin, &rec) != BL_READ_EOF )
46    bl_fastq_write(stdout, &rec, BL_FASTQ_LINE_UNLIMITED);
47bl_fastq_free(&rec);
48.ad
49.fi
50
51.SH SEE ALSO
52
53bl_fastq_read(3), bl_fastq_read(3), bl_fastq_write(3),
54
55