L3DT documentation
Large 3D terrain generator

zmap_SaveFile

Description

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

Files

Declaration Zeolite.h
Implementation Zeolite.cpp

Function prototype

bool zmap_SaveFile(ZMAP hMap, const char* lpFileName, ZFORMAT hFormat, bool SetFlags, bool ShowProgress);

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 zformat_GetFormatByExt or zformat_GetFormatByExt2 to explicitly retrieve a valid hFormat instead.

 
zeolite/functions/zmap_savefile.txt · Last modified: 2017/08/31 04:47 (external edit)
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki