Difference between revisions of "ISInterface:UnloadSet"
Jump to navigation
Jump to search
Onetimehero (talk | contribs) |
|||
| Line 2: | Line 2: | ||
*bool UnloadSet(unsigned long &SetGUID) | *bool UnloadSet(unsigned long &SetGUID) | ||
== Purpose == | == Purpose == | ||
| − | To unload a given set | + | To unload a given set. The set referenced by SetGUID will be erased from memory, including all subsets, settings, and comments. The SetGUID is invalid after this call completes successfully. |
== Usage == | == Usage == | ||
=== Parameters === | === Parameters === | ||
Latest revision as of 16:36, 8 September 2006
Syntax
- bool UnloadSet(unsigned long &SetGUID)
Purpose
To unload a given set. The set referenced by SetGUID will be erased from memory, including all subsets, settings, and comments. The SetGUID is invalid after this call completes successfully.
Usage
Parameters
- unsigned long &SetGUID
- [in] unique identifier of the set to unload
Return Value
- bool
- Returns true on success, false on failure
Examples
- pISInterface->UnloadSet(parentsetguid);
