FileMappingMode - SeqAn API Documentation

# Enum FileMappingMode
Flags to determine the mapping mode of mapFileSegment.

Defined in | <seqan/file.h>
Signature | `enum FileMappingMode;`

## Enum Values

`MAP_RDONLY = 1` | Map the segment in read-only mode.
`MAP_WRONLY = 2` | Map the segment in write-only mode.
`MAP_RDWR = 3` | Map the segment for reading and writing.
`MAP_COPYONWRITE = 4` | Write accesses are not written back to file and not shared among different mappings.

## Detailed Description

The mapping mode must be compatible to the open mode of a FileMapping, e.g. `MAP_RDWR` is not allowed if the file mapping was opened with `OPEN_RDONLY`.

#### Dox Sources

    /*!
     * @enum FileMappingMode
     *
     * @headerfile <seqan/file.h>
     *
     * @brief Flags to determine the mapping mode of mapFileSegment.
     *
     * @signature enum FileMappingMode;
     *
     * The mapping mode must be compatible to the open mode of a @link FileMapping
     * @endlink, e.g. <tt>MAP_RDWR</tt> is not allowed if the file mapping was
     * opened with <tt>OPEN_RDONLY</tt>.
     *
     * @val FileMappingMode MAP_RDONLY = 1;
     *
     * @brief Map the segment in read-only mode.
     *
     * @val FileMappingMode MAP_WRONLY = 2;
     *
     * @brief Map the segment in write-only mode.
     *
     * @val FileMappingMode MAP_RDWR = 3;
     *
     * @brief Map the segment for reading and writing.
     *
     * @val FileMappingMode MAP_COPYONWRITE = 4;
     *
     * @brief Write accesses are not written back to file and not shared among
     *        different mappings.
     */