Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
fastq_trim..._phred_base(3) Library Functions Manual fastq_trim..._phred_base(3)

LIBRARY
     #include <fastq-trim.h>
     -lfastq-trim

SYNOPSIS
     int      fastq_trim_set_phred_base(fastq_trim_t  *fastq_trim_ptr,	unsigned
     new_phred_base)

ARGUMENTS
     fastq_trim_ptr  Pointer to the structure to set
     new_phred_base  The new value for phred_base

DESCRIPTION
     Mutator for phred_base member in a fastq_trim_t structure.  Use this  func-
     tion  to  set  phred_base	in a fastq_trim_t variable from non-member func-
     tions.  This function performs a direct assignment for  scalar  or  pointer
     structure	members.  If phred_base is a pointer, data previously pointed to
     should generally be freed before calling  this  function  to  avoid  memory
     leaks.

     Note  that  there	is  an equivalent macro (), which performs this function
     with no data verification or function call overhead.  Use the macro version
     to maximize performance where the validity of new_phred_base is  guaranteed
     by other means.

RETURN VALUES
     FASTQ_TRIM_DATA_OK   if   the   new   value   is  acceptable  and	assigned
     FASTQ_TRIM_DATA_OUT_OF_RANGE otherwise

EXAMPLES
     fastq_trim_t    fastq_trim;
     unsigned	     new_phred_base;

     if ( fastq_trim_set_phred_base(&fastq_trim, new_phred_base) == FASTQ_TRIM_DATA_OK )
     {
     }

SEE ALSO
     (3)

						     fastq_trim..._phred_base(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=fastq_trim_set_phred_base&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help