1\" Generated by c2man from bl_fastq_set_seq_len.c
2.TH bl_fastq_set_seq_len 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
17.nf
18.na
19int     bl_fastq_set_seq_len(bl_fastq_t *bl_fastq_ptr, size_t new_seq_len)
20.ad
21.fi
22
23.SH ARGUMENTS
24.nf
25.na
26bl_fastq_ptr    Pointer to the structure to set
27new_seq_len     The new value for seq_len
28.ad
29.fi
30
31.SH DESCRIPTION
32
33Mutator for seq_len member in a bl_fastq_t structure.
34Use this function to set seq_len in a bl_fastq_t variable
35from non-member functions.  This function performs a direct
36assignment for scalar or pointer structure members.  If
37seq_len is a pointer, data previously pointed to should
38generally be freed before calling this function to avoid memory
39leaks.
40
41Note that there is an equivalent macro (), which performs
42this function with no data verification or function call overhead.
43Use the macro version to maximize performance where the validity
44of new_seq_len is guaranteed by other means.
45
46.SH EXAMPLES
47.nf
48.na
49
50bl_fastq_t      bl_fastq;
51size_t          new_seq_len;
52
53if ( bl_fastq_set_seq_len(&bl_fastq, new_seq_len) == BL_DATA_OK )
54{
55}
56.ad
57.fi
58
59.SH SEE ALSO
60
61(3)
62
63