Function
open
Opens a file, stream, or persistent string.
open(object, filename[ ,openMode])
open(string, fileName[, openMode]))
open(file, fileName[, openMode])
open(stream, fileName, mode)
Include Headers
seqan/file.h
Parameters
string
A persistent string, e.g. a External String or MMap String.
object
The object to be opened.
file
A File object.
Types: File
fileName
C-style character string containing the file name.
openMode
The combination of flags defining how the file should be opened. See FileOpenMode for more details.
Default: OPEN_RDWR | OPEN_CREATE | OPEN_APPEND
Remarks: If you omit the OPEN_APPEND flag in write mode, the file will be cleared when opened.
stream
Stream to open.
mode
Mode string for opening the file, e.g. "r", "w".
Types: char const *
Remarks: When opening Stream<Bgzf> for writing, you can append '0'-'9' or 'u' to "w" for setting the compression level to 0-9 or "no compression".
Do not specify for Char Array Stream.
Return Values
A bool which is true on success.
SeqAn - Sequence Analysis Library - www.seqan.de
 

Page built @2013/07/11 09:12:18