1\" Generated by c2man from bl_fastx_desc_len.c
2.TH bl_fastx_desc_len 3
3
4.SH LIBRARY
5\" Indicate #includes, library name, -L and -l flags
6.nf
7.na
8#include <biolibc/fastx.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
17size_t  bl_fastx_desc_len(bl_fastx_t *record)
18
19.SH ARGUMENTS
20.nf
21.na
22record  Pointer to the bl_fastx_t structure
23.ad
24.fi
25
26.SH DESCRIPTION
27
28Return the length of the description string of a FASTA or FASTQ
29record.  The record must be initialized with bl_fastx_init(3)
30and populated by bl_fastx_read(3) or other means.  Previously used
31variables may be reused to process another record in the same
32format (FASTA or FASTQ) or reinitialized by bl_fastx_free(3);
33
34.SH RETURN VALUES
35
36Length of the description string
37
38.SH EXAMPLES
39.nf
40.na
41
42bl_fastx_t  record = BL_FASTX_INIT;
43
44bl_fastx_init(stdin, &record);
45bl_fastx_read(stdin, &record);
46printf("Desc string length = %zun", bl_fastx_desc_len(&record));
47bl_fastx_free(&record);
48.ad
49.fi
50
51.SH SEE ALSO
52
53bl_fastx_init(3), bl_fastx_read(3), bl_fastx_write(3),
54bl_fastx_free(3)
55
56