ServerBrowserAuxUpdateIP
Queries key/values from a single server.
- SBError ServerBrowserAuxUpdateIP(
- ServerBrowser sb,
- const gsi_char * ip,
- unsigned short port,
- SBBool viaMaster,
- SBBool async,
- SBBool fullUpdate );
Routine | Required Header | Distribution |
---|---|---|
ServerBrowserAuxUpdateIP | <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.
- ip
- [in] Address string of the game server.
- port
- [in] Query port of the game server, in network byte order.
- viaMaster
- [in] Set to SBTrue to retrieve cached values from the master server.
- 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 ServerBrowserAuxUpdateIP 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
Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
---|---|---|
ServerBrowserAuxUpdateIP | ServerBrowserAuxUpdateIPA | ServerBrowserAuxUpdateIPW |
ServerBrowserAuxUpdateIPW and ServerBrowserAuxUpdateIPA are UNICODE and ANSI mapped versions of ServerBrowserAuxUpdateIP. The arguments of ServerBrowserAuxUpdateIPA are ANSI strings; those of ServerBrowserAuxUpdateIPW are wide-character strings.
Section Reference: Gamespy Server Browsing SDK
See Also: ServerBrowserUpdate, ServerBrowserLANUpdate, ServerBrowserAuxUpdateServer