BSKCleanupReturnValue

Module: BSKExec
void BSKCleanupReturnValue( BSKValue* value );
Inputs:

Description: "Cleans up" the given value. The value is invalidated at the very least (see BSKInvalidateValue), but if the value is a thing or category, its members and/or attributes are recursively descended and cleaned up, and all objects not owned by the database are destroyed (ownerLevel != 0).

You must call this routine on the value returned by BSKExec when you are done with it, or you may end up with memory leaks.

This function should only be used on the 'rval' field of the BSKExecOpts structure after returning successfully from BSKExec. Its results are undefined if used on other values.

Return to the API
Return to the function listing


Last updated on 9 Feb 2001 by Jamis Buck (minam@rpgplanet.com)