home | help
bl_fastx_desc(3)	    Library Functions Manual		bl_fastx_desc(3)

NAME
     bl_fastx_desc() - Return  description of a FASTX object

LIBRARY
     #include <biolibc/fastx.h>
     -lbiolibc -lxtend

SYNOPSIS
     char    *bl_fastx_desc(bl_fastx_t *record)

ARGUMENTS
     record  Pointer to the bl_fastx_t structure

DESCRIPTION
     Return a pointer to the description string of a FASTA or FASTQ record.  The
     record   must   be  initialized  with  bl_fastx_init(3)  and  populated  by
     bl_fastx_read(3) or other means.  Previously used variables may  be  reused
     to process another record in the same format (FASTA or FASTQ) or reinitial-
     ized by bl_fastx_free(3);

RETURN VALUES
     Pointer to the description string

EXAMPLES
     bl_fastx_t  record = BL_FASTX_INIT;

     bl_fastx_init(stdin, &record);
     bl_fastx_read(stdin, &record);
     printf("Desc string = %sn", bl_fastx_desc(&record));
     bl_fastx_free(&record);

SEE ALSO
     bl_fastx_init(3), bl_fastx_read(3), bl_fastx_write(3), bl_fastx_free(3)

								bl_fastx_desc(3)

home | help