ServerBrowserAuxUpdateServer

GameSpy SDK

ServerBrowserAuxUpdateServer

Query key/values from a single server that has already been added to the internal list.

SBError ServerBrowserAuxUpdateServer(
ServerBrowser sb,
SBServer server,
SBBool async,
SBBool fullUpdate );
RoutineRequired HeaderDistribution
ServerBrowserAuxUpdateServer<sb_serverbrowsing.h>SDKZIP

Return Value

This function returns sbe_noerror for success. On an error condition, this function will return an SBError code. If the async option is SBTrue, the status condition will be reported to the SBCallback.

Parameters

sb
[in] ServerBrowser object returned from ServerBrowserNew.
server
[in] SBServer object for the server to update. (usually obtained from SBCallback)
async
[in] Set to SBTrue to run in non-blocking mode.
fullUpdate
[in] Set to SBTrue to retreive the full set of key/values from the server.

Remarks

The ServerBrowserAuxUpdateServer function is used to retrieve information about a specific server. Information returned is in the form of key/value pairs and may be accessed through the standard SBServer object accessors.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
ServerBrowserAuxUpdateServerServerBrowserAuxUpdateServerAServerBrowserAuxUpdateServerW

ServerBrowserAuxUpdateServerW and ServerBrowserAuxUpdateServerA are UNICODE and ANSI mapped versions of ServerBrowserAuxUpdateServer. The arguments of ServerBrowserAuxUpdateServerA are ANSI strings; those of ServerBrowserAuxUpdateServerW are wide-character strings.