kzs_mmap.hpp File Reference

Macros

#define KZ_FEATURE_MMAP
 
#define KZS_MMAP_H
 

Functions

kzBool kzsMemoryMappedFileIsSupported (void)
 Returns true if memory mapped files are supported on this platform. More...
 
kzsError kzsMemoryMappedFileCreate (kzString filePath, struct KzsMemoryMappedFile **out_memoryMappedFile)
 Opens a memory mapped file. More...
 
kzsError kzsMemoryMappedFileDelete (struct KzsMemoryMappedFile *memoryMappedFile)
 Closes a memory mapped file. More...
 
kzBool kzsMemoryMappedFileIsValid (kzString filePath)
 Returns true if the file exists and is over 0 bytes in size. More...
 
kzSizeT kzsMemoryMappedFileGetSize (const struct KzsMemoryMappedFile *memoryMappedFile)
 Returns the size of the memory mapped file. More...
 
void * kzsMemoryMappedFileGetPointer (const struct KzsMemoryMappedFile *memoryMappedFile)
 Returns the address of the beginning of the memory mapped file. More...
 

Macro Definition Documentation

#define KZ_FEATURE_MMAP
#define KZS_MMAP_H

Copyright 2008-2017 by Rightware. All rights reserved.

Function Documentation

kzBool kzsMemoryMappedFileIsSupported ( void  )

Returns true if memory mapped files are supported on this platform.

kzsError kzsMemoryMappedFileCreate ( kzString  filePath,
struct KzsMemoryMappedFile **  out_memoryMappedFile 
)

Opens a memory mapped file.

kzsError kzsMemoryMappedFileDelete ( struct KzsMemoryMappedFile *  memoryMappedFile)

Closes a memory mapped file.

kzBool kzsMemoryMappedFileIsValid ( kzString  filePath)

Returns true if the file exists and is over 0 bytes in size.

kzSizeT kzsMemoryMappedFileGetSize ( const struct KzsMemoryMappedFile *  memoryMappedFile)

Returns the size of the memory mapped file.

void* kzsMemoryMappedFileGetPointer ( const struct KzsMemoryMappedFile *  memoryMappedFile)

Returns the address of the beginning of the memory mapped file.