fn() split

Divides the contents of a sequence file into sequence file fragments separated by a file format specific delimiter.

/*!
 * @fn split
 * 
 * @headerfile <seqan/file.h>
 * 
 * @brief Divides the contents of a sequence file into sequence file fragments
 *        separated by a file format specific delimiter.
 * 
 * @signature void split(stringSet, formatTag);
 * 
 * @param[in,out] stringSet A @link ConcatDirectStringSet @endlink. The
 *                          <tt>concat</tt> member (concatenation string)
 *                          contains the contents of a sequence file.
 * @param[in] formatTag A file format tag.
 * 
 * @section Remarks
 * 
 * The @link ConcatDirectStringSet::concat @endlink member should contain the
 * contents of the sequence file by a prior call of <tt>open</tt>.
 * 
 * This function expects a @link ConcatDirectStringSet @endlink and divides the
 * underlying concatenation string into sequence fragments separated by a file
 * format specific delimiter.
 * 
 * After calling this function, the StringSet length is the number of sequence
 * fragments and each fragment can be retrieve by <tt>value</tt> or
 * <tt>getValue</tt>.
 */