ServerBrowserUpdate
Retrieves the current list of games from the GameSpy master server.
- SBError ServerBrowserUpdate(
- ServerBrowser sb,
- SBBool async,
- SBBool disconnectOnComplete,
- const unsigned char * basicFields,
- int numBasicFields,
- const gsi_char * serverFilter );
Routine | Required Header | Distribution |
---|---|---|
ServerBrowserUpdate | <sb_serverbrowsing.h> | SDKZIP |
Return Value
If an error occurs, a valid SBError error code is returned. Otherwise, sbe_noerror is returned.
Parameters
- sb
- [in] ServerBrowser object intialized with ServerBrowserNew.
- async
- [in] When set to SBTrue this function will run in non-blocking mode.
- disconnectOnComplete
- [in] When set to SBTrue this function will terminate the connection with the GameSpy master after the download is complete.
- basicFields
- [in] A byte array of basic field identifiers to retreive for each server. See remarks.
- numBasicFields
- [in] The number of valid fields in the basicFields array.
- serverFilter
- [in] SQL like string used to remove unwanted servers from the downloaded list.
Remarks
The ServerBrowserUpdate function retrieves the current list of servers registered with the GameSpy master server. As each server entry is received, one corresponding call to the SBCallback function will be made with the status sbc_serveradded.
Unicode Mappings
Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
---|---|---|
ServerBrowserUpdate | ServerBrowserUpdateA | ServerBrowserUpdateW |
ServerBrowserUpdateW and ServerBrowserUpdateA are UNICODE and ANSI mapped versions of ServerBrowserUpdate. The arguments of ServerBrowserUpdateA are ANSI strings; those of ServerBrowserUpdateW are wide-character strings.
Section Reference: Gamespy Server Browsing SDK
See Also: ServerBrowserNew, ServerBrowserLANUpdate