Difference between revisions of "ISInterface:SetSetting"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
===Syntax=== | ===Syntax=== | ||
| − | + | *bool SetSetting(unsigned long &SetGUID, char *Setting, char *Value) | |
| + | *bool SetSetting(unsigned long &SetGUID, char *Setting, int iValue) | ||
| + | *bool SetSetting(unsigned long &SetGUID, char *Setting, unsigned long &ulValue) | ||
| + | *bool SetSetting(unsigned long &SetGUID, char *Setting, float &fValue) | ||
| + | *bool SetSetting(unsigned long &SetGUID, char *Setting, __int64 &Value) | ||
== Purpose == | == Purpose == | ||
| − | + | To set a setting in a given set | |
== Usage == | == Usage == | ||
=== Parameters === | === Parameters === | ||
| + | *unsigned long &SetGUID | ||
| + | :'''[in]''' Unique identifier of the set to set the '''Setting''' to | ||
| + | *char *Setting | ||
| + | :'''[in]''' Name of the setting to set | ||
| + | *char *Value | ||
| + | :'''[in]''' value to be set | ||
| + | *int iValue | ||
| + | :'''[in]''' value to be set | ||
| + | *unsigned long &ulValue | ||
| + | :'''[in]''' value to be set | ||
| + | *float &fValue | ||
| + | :'''[in]''' value to be set | ||
| + | *__int64 &Value | ||
| + | :'''[in]''' value to be set | ||
=== Return Value === | === Return Value === | ||
| − | + | *bool | |
| + | :Returns true on success, false on failure | ||
== Examples == | == Examples == | ||
| − | + | int numberofapples; | |
| + | numberofapples=12; | ||
| + | pISInterface->SetSetting(parentsetguid,"Apples",numberofapples); | ||
== See Also == | == See Also == | ||
Latest revision as of 01:39, 3 September 2005
Syntax
- bool SetSetting(unsigned long &SetGUID, char *Setting, char *Value)
- bool SetSetting(unsigned long &SetGUID, char *Setting, int iValue)
- bool SetSetting(unsigned long &SetGUID, char *Setting, unsigned long &ulValue)
- bool SetSetting(unsigned long &SetGUID, char *Setting, float &fValue)
- bool SetSetting(unsigned long &SetGUID, char *Setting, __int64 &Value)
Purpose
To set a setting in a given set
Usage
Parameters
- unsigned long &SetGUID
- [in] Unique identifier of the set to set the Setting to
- char *Setting
- [in] Name of the setting to set
- char *Value
- [in] value to be set
- int iValue
- [in] value to be set
- unsigned long &ulValue
- [in] value to be set
- float &fValue
- [in] value to be set
- __int64 &Value
- [in] value to be set
Return Value
- bool
- Returns true on success, false on failure
Examples
int numberofapples; numberofapples=12; pISInterface->SetSetting(parentsetguid,"Apples",numberofapples);
