zmap_GetNameInProject

zmap_GetNameInProject

Description

Retrieve the name of a map as it appears in the project's map list. This is the name used in the zproj_GetMap and zview_ShowMap functions, amongst others. The name is set in the zproj_CreateMap function, and cannot be changed thereafter.

Files

Declaration	`Zeolite.h`
Implementation	`Zeolite.cpp`

Function prototype

const char* zmap_GetNameInProject(ZMAP hMap);

Arguments

Name	Type	Comment
hMap	`ZMAP`	A ZVAR handle to a VarID_map variable, the name of which is to be retrieved.

Return value

A null handle if:

The map handle is invalid.
The map is valid, but the map is not named in the project.

Otherwise, a non-null C-style string is returned.

Comments

None.