GPProfileSearchResponseArg

GameSpy SDK

GPProfileSearchResponseArg

The arg parameter passed to a callback generated by a call to gpProfileSearch is of this type. Contains information about the profiles that matched the search criteria.

typedef struct 
{
GPResult result;
int numMatches;
GPEnum more;
GPProfileSearchMatch * matches;
} GPProfileSearchResponseArg;

Members

result
The result of the inquiry; GP_NO_ERROR if successful.
numMatches
The number of profiles in the matches list.
more
[In/Out] GP_MORE if there are more matches to come; GP_DONE if this is the last (or only) batch of matches.
matches
A list of information for the matching profiles.

Remarks

The callback for gpProfileSearch will only receive a limited number of results in each batch. If there are more results than those passed to the callback, the more member of the structure will be set to GP_MORE. If there are no more results, more will be set to GP_DONE.
The callback routine can leave more set to GP_MORE, which will tell the SDK to deliver the next batch of results, or it change more to GP_DONE, which will tell the SDK to stop delivering information.