Difference between revisions of "ISInterface:GetGameSetting"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
===Syntax=== | ===Syntax=== | ||
| − | + | *bool GetGameSetting(char *Setting, char *buf, unsigned long buflen) | |
== Purpose == | == Purpose == | ||
| − | + | To obtain a game setting | |
== Usage == | == Usage == | ||
=== Parameters === | === Parameters === | ||
| − | + | *char *Setting | |
| + | :'''[in]''' Name of the setting to obtain | ||
| + | *char *buf | ||
| + | :'''[out]''' Buffer to put the setting into | ||
| + | *unsigned long buflen | ||
| + | :'''[in]''' Length of the buffer | ||
=== Return Value === | === Return Value === | ||
| − | + | *bool | |
| + | :Returns true on success, false on failure | ||
== Examples == | == Examples == | ||
| − | + | char gamesettingbuffer[1024]; | |
| + | pISInterface->GetGameSetting("modules",gamesettingbuffer,sizeof(gamesettingbuffer)); | ||
== See Also == | == See Also == | ||
Latest revision as of 01:59, 3 September 2005
Syntax
- bool GetGameSetting(char *Setting, char *buf, unsigned long buflen)
Purpose
To obtain a game setting
Usage
Parameters
- char *Setting
- [in] Name of the setting to obtain
- char *buf
- [out] Buffer to put the setting into
- unsigned long buflen
- [in] Length of the buffer
Return Value
- bool
- Returns true on success, false on failure
Examples
char gamesettingbuffer[1024];
pISInterface->GetGameSetting("modules",gamesettingbuffer,sizeof(gamesettingbuffer));
