Table of Contents

zvar_Delete

Description

Delete a variable.

Files

Declaration Zeolite.h
Implementation Zeolite.cpp

Function prototype

bool zvar_Delete(ZVAR& hVar);

Arguments

Name Type Comment
hVar ZVAR& A ZVAR handle to the variable to be deleted, passed by reference.

Return value

False if an error occurred, and true otherwise.

Comments

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.