ServerBrowserErrorDesc
Returns a human readable string for the specified SBError.
- const gsi_char * ServerBrowserErrorDesc(
- ServerBrowser sb,
- SBError error );
| Routine | Required Header | Distribution |
|---|---|---|
| ServerBrowserErrorDesc | <sb_serverbrowsing.h> | SDKZIP |
Return Value
For a valid SBError, this function will return a human readable description. Otherwise this function returns an empty string.
Parameters
- sb
- [in] ServerBrowser object intialized with ServerBrowserNew.
- error
- [in] A valid SBError code.
Remarks
The ServerBrowserErrorDesc function is usefull for displaying error information to a user that might not understand SBError codes. These descriptions are in english. For localization purposes, you will need to provide your own translation functions.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| ServerBrowserErrorDesc | ServerBrowserErrorDescA | ServerBrowserErrorDescW |
ServerBrowserErrorDescW and ServerBrowserErrorDescA are UNICODE and ANSI mapped versions of ServerBrowserErrorDesc. The arguments of ServerBrowserErrorDescA are ANSI strings; those of ServerBrowserErrorDescW are wide-character strings.
Section Reference: Gamespy Server Browsing SDK
See Also: ServerBrowserNew, ServerBrowserListQueryError