====== CzVar::GetValue ======

===== Description =====

Retrieve the value of the variable attached to this CzVar object, ensuring first it is of the correct [[zeolite:varID|variable type]].

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

<code>bool CzVar::GetValue(long VarID, void* pValue);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| VarID | long | The expected [[zeolite:varID|type ID]] of the variable. |
| pValue | void* | A user-supplied handle to an allocated block of memory for the appropriate data type, ready to receive the value from the variable. |

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

False if:
  - //pValue// is null.
  - The variable is not initialised as the type given by //VarID//.
  - The variable cannot be copied (see [[zeolite:functions:var_GetValue#Comments|comments for var_GetValue]].)
True otherwise.

===== Comments =====

This function is equivalent to the API function [[zeolite:functions:var_GetValueEx]]. Please refer to the documentation of that function for additional information.