ServerBrowserLimitUpdate
Retrieves the current limited list of games from the GameSpy master server. Useful for low-memory systems.
- SBError ServerBrowserLimitUpdate(
- ServerBrowser sb,
- SBBool async,
- SBBool disconnectOnComplete,
- const unsigned char * basicFields,
- int numBasicFields,
- const gsi_char * serverFilter,
- int maxServers );
Routine | Required Header | Distribution |
---|---|---|
ServerBrowserLimitUpdate | <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.
- maxServers
- [in] Maximum number of servers to be returned
Remarks
The ServerBrowserLimitUpdate function retrieves a limited set of the servers registered with the GameSpy master server. This is most useful for low memory systems such as the PS2 which may not be capable of loading an entire server list.
Identical to ServerBrowserUpdate, except that the number of servers returned can be limited.
Unicode Mappings
Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
---|---|---|
ServerBrowserLimitUpdate | ServerBrowserLimitUpdateA | ServerBrowserLimitUpdateW |
ServerBrowserLimitUpdateW and ServerBrowserLimitUpdateA are UNICODE and ANSI mapped versions of ServerBrowserLimitUpdate. The arguments of ServerBrowserLimitUpdateA are ANSI strings; those of ServerBrowserLimitUpdateW are wide-character strings.
Section Reference: Gamespy Server Browsing SDK
See Also: ServerBrowserNew, ServerBrowserUpdate