/****************************** Module Header *******************************
*
* Module Name: mmf.h
*
* Header for generic routines for memory mapped files
*
* This code bases on the MMF library by Sergey I. Yevtushenko
*
* Copyright (c) Netlabs EPM Distribution Project 2002
*
* $Id$
*
* ===========================================================================
*
* This file is part of the Netlabs EPM Distribution package and is free
* software.  You can redistribute it and/or modify it under the terms of the
* GNU General Public License as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* Netlabs EPM Distribution.  This library is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* General Public License for more details.
*
****************************************************************************/

#ifndef  MMF_H
#define  MMF_H

/* flags for MmfAlloc parm ulOpenFlags                                       */
/* NOTE: for all except MMF_ACCESS_READWRITE, only write by others is denied */
/*       otherwise both read and write by others is denied                   */

#define MMF_ACCESS_READONLY     0x00000000
#define MMF_ACCESS_WRITEONLY    0x00000001
#define MMF_ACCESS_READWRITE    0x00000002

#define MMF_OPENMODE_OPENFILE   0x00000000
#define MMF_OPENMODE_RESETFILE  0x00010000

/* some sizes for usage with MmfAlloc parameter ulMaxSize */
#define MMF_MAXSIZE_KB             1024
#define MMF_MAXSIZE_MB          1048576

/* special NULL filename for MmfAlloc parameter pszFilename */
#define MMF_FILE_INMEMORY       NULL


/* define a handle type */
typedef LHANDLE HMMF, *PHMMF;

/* prototypes */
APIRET MmfInitialize( PHMMF phmmf, ULONG ulMaxBuffer);
APIRET MmfTerminate( HMMF hmmf);
APIRET MmfAlloc( HMMF hmmf, PVOID *ppvdata, PSZ pszFilename, ULONG ulOpenFlags, ULONG ulMaxSize);
APIRET MmfFree( HMMF hmmf, PVOID pvData);
APIRET MmfUpdate( HMMF hmmf, PVOID pvData);

APIRET MmfSetSize( HMMF hmmf, PVOID pvData, ULONG ulNewSize);
APIRET MmfQuerySize( HMMF hmmf, PVOID pvData, PULONG pulSize);

#endif /* MMF_H */