Difference between revisions of "ISInterface:ClearSet"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 2: Line 2:
 
*bool ClearSet(unsigned long &SetGUID)
 
*bool ClearSet(unsigned long &SetGUID)
 
== Purpose ==
 
== Purpose ==
To clear an entire set
+
To clear an entire set.  All child Subsets, Settings, and Comments are removed from memory, but the set itself still remains.
 
== Usage ==
 
== Usage ==
 
=== Parameters ===
 
=== Parameters ===

Latest revision as of 16:34, 8 September 2006

Syntax

  • bool ClearSet(unsigned long &SetGUID)

Purpose

To clear an entire set. All child Subsets, Settings, and Comments are removed from memory, but the set itself still remains.

Usage

Parameters

  • unsigned long &SetGUID
[in] unique identifier of the set to clear

Return Value

  • bool
Returns true on success, false on failure

Examples

  • pISInterface->ClearSet(fruitguid);

See Also