====== zvar_IsType ======

===== Description =====

Test whether a variable is initialised as a given [[zeolite:varID|type ID]].

===== Files =====

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

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

<code="C">bool zvar_IsType(ZVAR hVar, long VarID);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| hVar | ZVAR | A ZVAR handle to a variable, the type of which is to be tested. |
| VarID | long | A long integer containing the [[zeolite:varID|variable type ID]] to be tested. |

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

False if:
  * The //hVar// argument does not refer to a valid variable (e.g. is null).
  * The variable is a type other than that given by //VarID//.
True otherwise.

===== Comments =====

None.