L3DT documentation
Large 3D terrain generator
Nav | start » zeolite » functions » map_setbusyflag
Table of Contents

map_SetBusyFlag

Description

Flag a map to be 'busy', typically meaning the map is in use by a calculation. Maps that are busy cannot be deallocated by map_Free.

Function prototype

bool CExtAPI::map_SetBusyFlag(ZMAP hMap, bool BusyFlag);

Arguments

Name Type Comment
hMap ZMAP A ZMAP handle to a map variable, the busy flag of which is to be set.
BusyFlag bool The desired state of the busy flag.

Return value

False if:

  • hMap does not point to a valid map variable.
  • The map is not allocated.
  • SetBusy is true, and the map is already busy (see map_GetBusyFlag).
  • An unspecified error occurred.

True otherwise.

Comments

None.

 
zeolite/functions/map_setbusyflag.txt · Last modified: 2017/08/31 05:13 (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