CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csutil/csmmap.h File Reference

Memory mapping interface. More...

#include "csextern.h"

Go to the source code of this file.

Functions

bool MemoryMapFile (mmioInfo *info, char const *filename)
 Map a file to a memory area.

void UnMemoryMapFile (mmioInfo *info)
 Unmap a file from a memory area.

bool MemoryMapWindow (mmioInfo *, char const *filename, unsigned int offset, unsigned int len, bool writable)
 Memory map in part of a file.

bool MemoryMapWindow (mmioInfo *, mmioInfo *original, unsigned int offset, unsigned int len, bool writable)
 Memory map in another part of an already mapped file.


Detailed Description

Memory mapping interface.

BE AWARE that the functions here are very platform-dependent, they even might not be available at all. For platform-independence don't use the routines here, use the csMemoryMappedIO class.

Definition in file csmmap.h.


Function Documentation

bool MemoryMapFile mmioInfo *    info,
char const *    filename
 

Map a file to a memory area.

Fills in the mmioInfo struct by mapping in filename. filename is a platform-dependent path. Returns true on success, false otherwise.

bool MemoryMapWindow mmioInfo *   ,
mmioInfo *    original,
unsigned int    offset,
unsigned int    len,
bool    writable
 

Memory map in another part of an already mapped file.

Provides more control than the standard MemoryMapFile(). The mmioInfo struct is compatible, UnMapMemoryFile() should be used to unmap. This struct will reuse filehandles and any other possible resource from the already mapped file.

bool MemoryMapWindow mmioInfo *   ,
char const *    filename,
unsigned int    offset,
unsigned int    len,
bool    writable
 

Memory map in part of a file.

Provides more control than the standard MemoryMapFile(). The mmioInfo struct is compatible, UnMapMemoryFile() should be used to unmap.

void UnMemoryMapFile mmioInfo *    info
 

Unmap a file from a memory area.


Generated for Crystal Space by doxygen 1.2.18