Difference between revisions of "ISInterface:UnloadSet"
Jump to navigation
Jump to search
Onetimehero (talk | contribs) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
===Syntax=== | ===Syntax=== | ||
| − | + | *bool UnloadSet(unsigned long &SetGUID) | |
== Purpose == | == 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 == | == Usage == | ||
=== Parameters === | === Parameters === | ||
| − | + | *unsigned long &SetGUID | |
| + | :'''[in]''' unique identifier of the set to unload | ||
=== Return Value === | === Return Value === | ||
| − | + | *bool | |
| + | :Returns true on success, false on failure | ||
== Examples == | == Examples == | ||
| − | + | *pISInterface->UnloadSet(parentsetguid); | |
== See Also == | == See Also == | ||
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);
