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 zmap_Free.

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

bool zmap_SetBusyFlag(ZMAP hMap, bool BusyFlag);

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.

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 zmap_GetBusyFlag).
An unspecified error occurred.

True otherwise.

None.