SBServerEnumKeys

GameSpy SDK

SBServerEnumKeys

Enumerates the keys/values for a given server by calling KeyEnumFn with each key/value.  The user-defined instance data will be passed to the KeyFn callback.

void SBServerEnumKeys(
SBServer server,
SBServerKeyEnumFn KeyFn,
void * instance );
RoutineRequired HeaderDistribution
SBServerEnumKeys<sb_serverbrowsing.h>SDKZIP

Parameters

server
[in] A valid SBServer object.
KeyFn
[in] A callback that is called once for each key.
instance
[in] A user-defined data value that will be passed into each call to KeyFn.

Remarks

The SBServerEnumKeys function is used to list the available keys for a particular SBServer object.  This is often useful when the number of keys or custom keys is unknown or variable.  Most often, the number of keys is predefined and constant, making this function call unnecessary.  No query is sent when enumerating keys, instead the keys are stored from the previous server update.