gpFindPlayers

GameSpy SDK

gpFindPlayers

This function finds players who are invitable to the given game.

GPResult gpFindPlayers(
GPConnection * connection,
int productID,
GPEnum blocking,
GPCallback callback,
void * param );
RoutineRequired HeaderDistribution
gpFindPlayers<gp.h>SDKZIP

Return Value

This function returns GP_NO_ERROR upon success. Otherwise a valid GPResult is returned.

Parameters

connection
[in] A GP connection interface.
productID
[in] The product ID you wish to invite players to.
blocking
[in] GP_BLOCKING or GP_NON_BLOCKING
callback
[in] A user-supplied callback with an arg type of GPFindPlayersResponseArg.
param
[in] Pointer to user-defined data. This value will be passed unmodified to the callback function.

Remarks

This function contacts the Search Manager and attempts to find all profiles that match the search criteria. A profile matches the provided search criteria only if it’s corresponding values are the same as those provided. Currently, there is no substring matching, and the criteria is case-sensitive.
When the search is complete, the callback will be called.

Section Reference: Gamespy Presence SDK

See Also: GPFindPlayersResponseArg