====== zmap_Init ======

===== Description =====

Initialise a map and allocate required memory.

===== Files =====

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

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

<code="C++">
bool zmap_Init(ZMAP hMap, long nx, long ny, long MapTypeID, float HorizScale, bool WrapFlag);
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //hMap//  |  ''ZMAP''  | a ZMAP handle to a map variable. |
|  //nx//  |  ''long''  | The number of pixels in the x-direction (width). |
|  //ny//  |  ''long''  | The number of pixels in the y-direction (height). |
|  //MapTypeID//  |  ''long''  | The integer identifier for the [[zeolite:mapid|map type]]. |
|  //HorizScale//  |  ''float''  | The distance between neighbouring pixels in the x- or y-axes, measured in metres. |
|  //WrapFlag//  |  ''bool''  | A boolean value indicating whether the left/right and top/bottom edges of the map 'wrap' around to produce an infinitely tiling map. |

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

False if an error occurred, and true otherwise.

===== Comments =====

None.