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

NAME
     bl_fastx_write() - Write a FASTX record

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

SYNOPSIS
     int     bl_fastx_write(bl_fastx_t *record, FILE *fastx_stream,
     size_t max_line_len)

ARGUMENTS
     fastx_stream    FILE stream to which data are written
     record	     Pointer to a bl_fastx_t structure to be written
     max_line_len    Maximum length of a sequence line in output

DESCRIPTION
     Write   a	 FASTA	 or   FASTQ   record  from  a  FILE  stream  by  calling
     bl_fasta_write(3) or  bl_fastq_write(3).	The  bl_fastx_t  structure  must
     first   be   initialized	by   assigning	 it  BL_FASTX_INIT  and  calling
     bl_fastx_init(3), and then 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  reinitialized  by  bl_fastx_free(3);  See
     bl_fasta_write(3) and bl_fastq_write(3) for further details.

RETURN VALUES
     BL_WRITE_OK upon success, BL_WRITE_FAILURE if a write error occurs.

EXAMPLES
     bl_fastx_t  rec = BL_FASTX_INIT;

     bl_fastx_init(stdin, &rec);
     while ( bl_fastx_read(stdin, &rec) != BL_READ_EOF )
	 bl_fastx_write(stdout, &rec, BL_FASTX_LINE_UNLIMITED);
     bl_fastx_free(&rec);

SEE ALSO
     bl_fastx_read(3), bl_fastq_read(3), bl_fastq_write(3),

							       bl_fastx_write(3)

home | help