====== 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 =====

<code>ZFORMAT CExtAPI::format_GetActiveFormat(const char* lpMapName, long MapTypeID);</code>

===== 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 [[zeolite:functions:project_GetMap]] for list of valid names. |
| MapTypeID | long | The map type ID for which the format will be retrieved (may be zero). [[zeolite:mapID|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 [[zeolite:functions:format_GetFormatByExt]] for comments regarding the proper use of //lpMapName// and //MapTypeID//.