SBServerGetBoolValue
Returns the value associated with the specified key. This value is returned as the appropriate type: SBBool, float, int or string.
- SBBool SBServerGetBoolValue(
- SBServer server,
- const gsi_char * key,
- SBBool bdefault );
| Routine | Required Header | Distribution |
|---|---|---|
| SBServerGetBoolValue | <sb_serverbrowsing.h> | SDKZIP |
Return Value
If the key is invalid or missing, the specified default is returned. For an existing key, the value is converted from string form to the appropriate data type. These functions do not perform any type checking.
Parameters
- server
- [in] A valid SBServer object.
- key
- [in] The value associated with this key will be returned.
- bdefault
- [in] The value to return if the key is not found.
Remarks
These functions are usefull for converting custom keys to a native data type. No type checking is performed, the string value is simply cast to the appropriate data type. If a key is not found,the supplied default is returned.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| SBServerGetBoolValue | SBServerGetBoolValueA | SBServerGetBoolValueW |
SBServerGetBoolValueW and SBServerGetBoolValueA are UNICODE and ANSI mapped versions of SBServerGetBoolValue. The arguments of SBServerGetBoolValueA are ANSI strings; those of SBServerGetBoolValueW are wide-character strings.
Section Reference: Gamespy Server Browsing SDK
See Also: ServerBrowserNew, ServerBrowserUpdate, ServerBrowserGetServer