====== zmap_SetBusyFlag ======

===== Description =====

Mark a map to be 'busy', typically meaning the map is in use by a calculation. Maps that are marked busy cannot be deallocated by [[zeolite:functions:zmap_Free]].

===== Files =====

^ Declaration | ''Zeolite.h'' |
^ Implementation | ''Zeolite.cpp'' |

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

<code="C++">
bool zmap_SetBusyFlag(ZMAP hMap, bool BusyFlag);
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //hMap//  |  ''ZMAP''  | A [[zeolite:types: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.
  * //BusyFlag// is true, but the map is already marked as busy (see [[zeolite:functions:zmap_GetBusyFlag]]).
  * An unspecified error occurred.
True otherwise.

===== Comments =====

None.