Difference between revisions of "ISInterface:GetSetting"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
===Syntax=== | ===Syntax=== | ||
| − | + | *bool GetSetting(unsigned long &SetGUID, char *Setting, char *buf, unsigned long buflen) | |
== Purpose == | == Purpose == | ||
| − | + | To get the value | |
== Usage == | == Usage == | ||
=== Parameters === | === Parameters === | ||
| + | *unsigned long &SetGUID | ||
| + | :'''[in]''' unique identifier of the set to get the setting from | ||
| + | *char *Setting | ||
| + | :'''[in]''' Name of the setting | ||
| + | *char *buf | ||
| + | :'''[out]''' Buffer to hold the value of the setting | ||
| + | *unsigned long buflen | ||
| + | :'''[in]''' Length of the buffer | ||
=== Return Value === | === Return Value === | ||
| − | + | *bool | |
| + | :Returns true on success, false on failure | ||
== Examples == | == Examples == | ||
| − | + | char settingbuffer[1024]; | |
| − | + | pISInterface->(parentsetguid,"favorite food",settingbuffer,sizeof(settingbuffer)); | |
| + | |||
== See Also == | == See Also == | ||
* [[ISXDK:ISInterface|ISInterface]] | * [[ISXDK:ISInterface|ISInterface]] | ||
Revision as of 01:13, 3 September 2005
Syntax
- bool GetSetting(unsigned long &SetGUID, char *Setting, char *buf, unsigned long buflen)
Purpose
To get the value
Usage
Parameters
- unsigned long &SetGUID
- [in] unique identifier of the set to get the setting from
- char *Setting
- [in] Name of the setting
- char *buf
- [out] Buffer to hold the value of the setting
- unsigned long buflen
- [in] Length of the buffer
Return Value
- bool
- Returns true on success, false on failure
Examples
char settingbuffer[1024]; pISInterface->(parentsetguid,"favorite food",settingbuffer,sizeof(settingbuffer));
