====== zmap_SaveFile ======

===== Description =====

Save a map as a single map file (non-mosaic.)

===== Files =====

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

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

<code="C">bool zmap_SaveFile(ZMAP hMap, const char* lpFileName, ZFORMAT hFormat, bool SetFlags, bool ShowProgress);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| hMap | ZMAP | A ZMAP handle to a map variable, the contents of which are to be saved to disk. |
| lpFileName | const char* | A handle to a C-style string containing the full path and extension of the file to be saved. |
| hFormat | ZFORMAT | A ZFORMAT handle to the format variable to be used to save the file. |
| SetFlags | bool | A boolean flag indicating whether this map should be flagged as saved, and have its active format and filename stored. |
| ShowProgress | bool | A boolean flag indicating whether the save operation should show a progress bar. |


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

False if an error occurred, and true otherwise.

===== Comments =====


==== Regarding hFormat ====

If the //hFormat// argument is null, L3DT will search for a format with a matching file extension within the format list for the map type of //hMap//.  This will often work, but it should not be relied upon. Please use [[zeolite:functions:zformat_GetFormatByExt]] or [[zeolite:functions:zformat_GetFormatByExt2]] to explicitly retrieve a valid //hFormat// instead.