====== zmap_GetFlag ======

===== Description =====

Retrieve the state of a flag for a map. See [[zeolite:functions:zmap_SetFlag#Allowed values of FlagID|zmap_SetFlag]] for the list of supported flags, and their meanings.

===== Files =====

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

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

<code="C++">
bool zmap_GetFlag(ZMAP hMap, long FlagID);
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //hMap//  |  ''ZMAP''  | A [[zeolite:types:ZMAP]] handle to a map, a flag of which is to be retrieved. |
|  //FlagID//  |  ''long''  | The ID of the flag to be retrieved. See [[zeolite:functions:zmap_SetFlag#Allowed values of FlagID|zmap_SetFlag]] for allowed values. |

===== Return value =====

True if the flag exists, and false otherwise.

===== Comments =====

Please refer to [[zeolite:functions:zmap_SetFlag#Comments|zmap_SetFlag]] for comments regarding the meaning of these flags.