Delete a variable.
Declaration | Zeolite.h |
---|---|
Implementation | Zeolite.cpp |
bool zvar_Delete(ZVAR& hVar);
Name | Type | Comment |
---|---|---|
hVar | ZVAR& | A ZVAR handle to the variable to be deleted, passed by reference. |
False if an error occurred, and true otherwise.
The zvar_Delete
function modifies the hVar
argument such that the handle is set to null, and cannot be used without first re-assigning it to another variable (e.g. using zvar_Create, zvar_GetSharedVar, zlist_GetItemA, etc). Using an unassigned ZVAR is a sure way to get a general protection fault from Windows.