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

FreeBSD Manual Pages

  
 
  

home | help
fastq_tri...tream1_cpy(3)  Library Functions Manual  fastq_tri...tream1_cpy(3)

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

SYNOPSIS
       int	 fastq_trim_set_outstream1_cpy(fastq_trim_t   *fastq_trim_ptr,
       FILE * new_outstream1, size_t array_size)

ARGUMENTS
       fastq_trim_ptr  Pointer to the structure	to set
       new_outstream1  The new value for outstream1
       array_size      Size of the outstream1 array.

DESCRIPTION
       Mutator for outstream1 member in	a fastq_trim_t	structure.   Use  this
       function	 to  set outstream1 in a fastq_trim_t variable from non-member
       functions.  This	function copies	the array pointed to by	new_outstream1
       to ->outstream1.

       Note that there is  an  equivalent  macro  FASTQ_TRIM_SET_OUTSTREAM1(),
       which performs this function with no data verification or function call
       overhead.   Use the macro version to maximize performance where the va-
       lidity of new_outstream1	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;
       FILE *	       new_outstream1;
       size_t	       array_size;

       if ( fastq_trim_set_outstream1(&fastq_trim, new_outstream1, array_size) == FASTQ_TRIM_DATA_OK )
       {
       }

SEE ALSO
       FASTQ_TRIM_SET_OUTSTREAM1(3)

						     fastq_tri...tream1_cpy(3)

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

home | help