ServerBrowserErrorDesc

GameSpy SDK

ServerBrowserErrorDesc

Returns a human readable string for the specified SBError.

const gsi_char * ServerBrowserErrorDesc(
ServerBrowser sb,
SBError error );
RoutineRequired HeaderDistribution
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

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
ServerBrowserErrorDescServerBrowserErrorDescAServerBrowserErrorDescW

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.