L3DT documentation
Large 3D terrain generator



Retrieve the value of a variable, ensuring first it is of the correct variable type.


Declaration Zeolite.h
Implementation Zeolite.cpp

Function prototype

bool zvar_GetValueEx(ZVAR hVar, long VarID, void* pValue);


Name Type Comment
hVar ZVAR A ZVAR handle to a variable, the value of which is to be retrieved.
VarID long The expected 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 ZVAR.

Return value

False if:

  1. hVar does not reference a valid variable (e.g. is null).
  2. pValue is null.
  3. The variable referenced by hVar is not initialised.
  4. The variable referenced by hVar is not of the type given by VarID.
  5. The variable type of hVar cannot be copied (see comments for zvar_GetValue.)

True otherwise.


Please refer to the comments for zvar_GetValue, which apply equally to this function.

zeolite/functions/zvar_getvalueex.txt · Last modified: 2017/08/31 04:38 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki