Table of Contents

format_GetDefaultFormat

Description

Retrieve the default file format handler for a particular map layer. The default format is set in the file preferences window.

Function prototype

ZFORMAT CExtAPI::format_GetDefaultFormat(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 the default 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.