====== zmap_GetScanlineArray ======

===== Description =====

Get the pointer to the array of scanlines of a map.

===== Files =====

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

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

<code="C++">
void** zmap_GetScanlineArray(ZMAP hMap);
</code>

===== Arguments =====

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

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

A null pointer if:
  * The map is not initialised, or;
  * The map is a mosaic (See ''[[zeolite:functions:zmap_GetMosaicFlag]]''), or;
  * The map is allocated as a contiguous block of memory (See ''[[zeolite:functions:zmap_IsContiguous]]''), or;
  * An error occurred.
Otherwise, the return value is the pointer to an array of pointers to the scanlines. The length of the array is given by  ''[[zeolite:functions:zmap_GetHeight]]''. Each member of the scanline array is a pointer to the first pixel of each scanline. The length of each scanline is given by ''[[zeolite:functions:zmap_GetWidth]]'', and the type and size of the pixel data in the scanlines may be retrieved from  ''[[zeolite:functions:zmap_GetMapType]]'' and ''[[zeolite:functions:zmap_GetPixelSize]]''.

===== Comments =====

None.