====== zmap_GetAllocMode ======

===== Description =====

Retrieve the memory allocation mode for a map.

===== Files =====

^ Declaration | ''Zeolite.h'' |
^ Implementation | ''Zeolite.cpp'' |

===== Function prototype =====

<code="C++">
unsigned long zmap_GetAllocMode(ZMAP hMap);
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //hMap//  |  ''ZMAP''  | A [[zeolite:types:ZMAP]] handle to a map variable. |

===== Return value =====

The following return values are defined in ''Zeolite_defines.h'':

^ Symbol  ^  Value  ^ Description ^
| MAPALLOC_INVALID |  0x0  | The map is not initialised or the ''ZMAP'' handle is not a valid map object. |
| MAPALLOC_RAM |  0x01  | The map is allocated as a single block of contiguous RAM.  |
| MAPALLOC_MOSAIC  |  0x02  | The map is split into a mosaic of tiles. |
| MAPALLOC_MOSAIC_TEMP |  0x04  | The map is temporarily split into a working mosaic in the L3DT temp directory, but will be loaded from / saved to a single map file in the project directory when the project is saved. |
| MAPALLOC_MOSAIC_SYSPAGEFILE |  0x10 | Same as ''MAPALLOC_MOSAIC_TEMP'', but the working copy is stored in the system page file. |
| MAPALLOC_MOSAIC_MEMMAPFILE |  0x20  | Same as ''MAPALLOC_MOSAIC_TEMP'', but the working copy is stored in a memory-mapped file. |

===== Comments =====

None.