L3DT documentation
Large 3D terrain generator

format_GetActiveFormat

Description

Retrieve the format currently used for a particular map layer within the project, or else the default format for that map layer type.

Function prototype

ZFORMAT CExtAPI::format_GetActiveFormat(const char* lpMapName, long MapTypeID);

Arguments

Name Type Comment
lpMapName const char* A handle to a C-style string containing the name of the map for which a format will be retrieved (may be null). See project_GetMap for list of valid names.
MapTypeID long The map type ID for which the format will be retrieved (may be zero). See here for a list of valid values.

Return value

A null pointer if an error occurred, and a valid non-null handle to a ZFORMAT variable otherwise.

Comments

lpMapName and MapTypeID

Please refer to format_GetFormatByExt for comments regarding the proper use of lpMapName and MapTypeID.

 
zeolite/functions/format_getactiveformat.txt · Last modified: 2017/08/31 06:30 (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