====== var_SetValue ======

===== Description =====

Set the value of a variable.

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

<code>bool CExtAPI::var_SetValue(ZVAR hVar, void* pValue);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| hVar | ZVAR | A ZVAR handle to a variable, the value of which is to be set. |
| pValue | void* | user-supplied handle to an allocated block of memory for the appropriate data type, containing the value to be set. |


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

False if:
  - //hVar// does not reference a valid variable (e.g. is null).
  - //pValue// is null.
  - The variable referenced by //hVar// is not initialised.
  - The variable type of //hVar// cannot be copied (see [[zeolite:functions:var_GetValue#Comments|comments for var_GetValue]].)
True otherwise.

===== Comments =====

Please refer to the comments for [[zeolite:functions:var_GetValue#Comments|var_GetValue]], which apply equally to this function.