Difference between revisions of "ISInterface:RemoveSetting"

From Lavish Software Wiki
Jump to navigation Jump to search
 
 
Line 1: Line 1:
 
===Syntax===
 
===Syntax===
 
+
*bool RemoveSetting(unsigned long &SetGUID, char *Setting)
 
== Purpose ==
 
== Purpose ==
 
+
To remove a specific setting in a set
 
== Usage ==
 
== Usage ==
 
=== Parameters ===
 
=== Parameters ===
 
+
*unsigned long &SetGUID
 +
:'''[in]''' unique identifier of the set the setting will be removed from
 +
*char *Setting
 +
:'''[in]''' Setting to be deleted
 
=== Return Value ===
 
=== Return Value ===
 
+
*bool
 +
:Returns true on success, false on failure
 
== Examples ==
 
== Examples ==
 
+
*pISInterface->RemoveSetting(fruitguid,"Apples");
  
 
== See Also ==
 
== See Also ==

Latest revision as of 01:04, 3 September 2005

Syntax

  • bool RemoveSetting(unsigned long &SetGUID, char *Setting)

Purpose

To remove a specific setting in a set

Usage

Parameters

  • unsigned long &SetGUID
[in] unique identifier of the set the setting will be removed from
  • char *Setting
[in] Setting to be deleted

Return Value

  • bool
Returns true on success, false on failure

Examples

  • pISInterface->RemoveSetting(fruitguid,"Apples");

See Also