====== 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 [[zeolite:functions:map_Free]].

===== Function prototype =====

<code>bool CExtAPI::map_SetBusyFlag(ZMAP hMap, bool BusyFlag);</code>

===== 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 [[zeolite:functions:map_GetBusyFlag]]).
  * An unspecified error occurred.
True otherwise.

===== Comments =====

None.