map_GetNameInProject

map_GetNameInProject

Description

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

Function prototype

const char* CExtAPI::map_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.