1\" Generated by c2man from bl_fastq_set_seq_cpy.c
2.TH bl_fastq_set_seq_cpy 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_cpy(bl_fastq_t *bl_fastq_ptr, char * new_seq, size_t array_size)
20.ad
21.fi
22
23.SH ARGUMENTS
24.nf
25.na
26bl_fastq_ptr    Pointer to the structure to set
27new_seq         The new value for seq
28array_size      Size of the seq array.
29.ad
30.fi
31
32.SH DESCRIPTION
33
34Mutator for seq member in a bl_fastq_t structure.
35Use this function to set seq in a bl_fastq_t variable
36from non-member functions.  This function copies the array pointed to
37by new_seq to ->seq.
38
39Note that there is an equivalent macro BL_FASTQ_SET_SEQ(), which performs
40this function with no data verification or function call overhead.
41Use the macro version to maximize performance where the validity
42of new_seq is guaranteed by other means.
43
44.SH EXAMPLES
45.nf
46.na
47
48bl_fastq_t      bl_fastq;
49char *          new_seq;
50size_t          array_size;
51
52if ( bl_fastq_set_seq(&bl_fastq, new_seq, array_size) == BL_DATA_OK )
53{
54}
55.ad
56.fi
57
58.SH SEE ALSO
59
60BL_FASTQ_SET_SEQ(3)
61
62