====== zvar_GetDataPtr ======
===== Description =====
Retrieve the raw memory handle to the data contained within a ZVAR.
===== Files =====
^ Declaration | ''Zeolite.h'' |
^ Implementation | ''Zeolite.cpp'' |
===== Function prototype =====
void* zvar_GetDataPtr(ZVAR hVar);
===== Arguments =====
^ Name ^ Type ^ Comment ^
| hVar | ZVAR | The handle to variable for which the data pointer is to be retrieved. |
===== Return value =====
A null pointer if:
* The variable is not initialised.
* The variable is of type VarID_void.
* An unspecified error occurred.
Otherwise, a valid handle is returned.
===== Comments =====
This function //should not be used//. If you need to set/get variable values, use [[zeolite:functions:zvar_SetValue]] / [[zeolite:functions:zvar_GetValue]]. If you need to manipulate data in class variables, use the relevant API functions (e.g. [[zeolite:functions:zformat_GetExt]]).