Querying Game Servers

Data Structures
struct	GS_PLAYERINFO
	A linked list containing player information. More...
struct	GS_PROPERTY
	A linked list containing miscellaneous server information. More...
struct	GS_SERVERINFO
	Server status information returned from GSQueryServer(). More...
Enumerations
enum	GS_TYPE {   GS_TYPE_QUAKEWORLD = 0, GS_TYPE_QUAKE2, GS_TYPE_QUAKE3, GS_TYPE_DOOM3,   GS_TYPE_HALFLIFE, GS_TYPE_UNREAL2, GS_TYPE_GAMESPY2, GS_TYPE_BFV,   GS_TYPE_PAINKILLER, GS_TYPE_UT2003, GS_TYPE_UT2004, GS_TYPE_UNREAL2XMP,   GS_TYPE_SOF2, GS_TYPE_RTCW, GS_TYPE_WOLFET, GS_TYPE_CS,   GS_TYPE_CSCZ, GS_TYPE_CALLOFDUTY, GS_TYPE_SWJKJA, GS_TYPE_MOHAA,   GS_TYPE_MOHBT, GS_TYPE_MOHSH, GS_TYPE_DOD, GS_TYPE_SOF,   GS_TYPE_GAMESPY, GS_TYPE_UT, GS_TYPE_SWJK2, GS_TYPE_DESCENT3,   GS_TYPE_AMERICASARMY, GS_TYPE_BF1942, GS_TYPE_HALO, GS_TYPE_POSTAL2,   GS_TYPE_STVEF, GS_TYPE_STVEF2, GS_TYPE_DEUSEX, GS_TYPE_IL2S,   GS_TYPE_IL2SFB, GS_TYPE_SOURCE, GS_TYPE_HALFLIFE2, GS_TYPE_CSS,   GS_TYPE_ASE, GS_TYPE_MTA, GS_TYPE_MTAVC, GS_TYPE_HERETIC2,   GS_TYPE_IGI2, GS_TYPE_GORE, GS_TYPE_VIETCONG, GS_TYPE_NWN,   GS_TYPE_SERIOUSSAM, GS_TYPE_SERIOUSSAM2, GS_TYPE_AOE2, GS_TYPE_AOE2TC,   GS_TYPE_AVP2, GS_TYPE_CHASER, GS_TYPE_CHROME, GS_TYPE_NOLF,   GS_TYPE_NOLF2, GS_TYPE_SHOGO, GS_TYPE_SOLDAT, GS_TYPE_CODENAMEEAGLE,   GS_TYPE_DEVASTATION, GS_TYPE_GIANTSCK, GS_TYPE_GLOBALOPS, GS_TYPE_NERFAB,   GS_TYPE_PURGEJIHAD, GS_TYPE_RSC, GS_TYPE_RALLYMASTERS, GS_TYPE_CCRENEGADE,   GS_TYPE_RUNE, GS_TYPE_SIN, GS_TYPE_TACTICALOPS, GS_TYPE_UCOMBAT,   GS_TYPE_UNREAL, GS_TYPE_WHEELOFTIME, GS_TYPE_XPANDRALLY, GS_TYPE_DDPT,   GS_TYPE_DTR2, GS_TYPE_DRAKAN, GS_TYPE_F12002, GS_TYPE_GUNMAN,   GS_TYPE_IRONSTORM, GS_TYPE_JBNF, GS_TYPE_KINGPIN, GS_TYPE_NFSHP2,   GS_TYPE_OPFLASHPOINT, GS_TYPE_REDLINE, GS_TYPE_TERMINUS, GS_TYPE_TUROK2,   GS_TYPE_TRON20, GS_TYPE_TRIBES, GS_TYPE_TRIBES2, GS_TYPE_THPS3,   GS_TYPE_THPS4, GS_TYPE_V8SCC, GS_TYPE_TEAMFACTOR, GS_TYPE_RAINBOWSIX,   GS_TYPE_RAINBOWSIXRS, GS_TYPE_NITRO, GS_TYPE_FARCRY, GS_TYPE_RISEOFNATIONS,   GS_TYPE_CONTRACTJACK, GS_TYPE_HOMEWORLD2, GS_TYPE_DAIKATANA, GS_TYPE_SAVAGE,   GS_TYPE_GHOSTRECON, GS_TYPE_BREED, GS_TYPE_MOHPA, GS_TYPE_OPFRESISTANCE,   GS_TYPE_SOAF, GS_TYPE_STBC, GS_TYPE_CODUO, GS_TYPE_SWBF,   GS_TYPE_TRIBES3 }
	Game server types. More...
Functions
GS_SERVERINFO *	GSQueryServer (unsigned short type, const char *host, unsigned short port)
	Queries a server for it's status information.
void	GSFreeServerInfo (GS_SERVERINFO *info)
	Frees the status information returned by GSQueryServer().
char *	GSStripColor (unsigned short type, char *out, const char *in)
	Strips any color or formatting from a string.

---

Enumeration Type Documentation

enum GS_TYPE

Game server types. Enumeration values: GS_TYPE_QUAKEWORLD  Quake World. GS_TYPE_QUAKE2  Quake 2. GS_TYPE_QUAKE3  Quake 3. GS_TYPE_DOOM3  Doom 3. GS_TYPE_HALFLIFE  Half-Life. GS_TYPE_UNREAL2  Unreal Engine 2. GS_TYPE_GAMESPY2  GameSpy Protocol 2. GS_TYPE_BFV  Battlefield Vietnam. GS_TYPE_PAINKILLER  Painkiller. GS_TYPE_UT2003  Unreal Tournament 2003. GS_TYPE_UT2004  Unreal Tournament 2004. GS_TYPE_UNREAL2XMP  Unreal 2 XMP. GS_TYPE_SOF2  Soldier of Fortune 2. GS_TYPE_RTCW  Return to Castle Wolfenstein. GS_TYPE_WOLFET  Wolfenstein: Enemy Territory. GS_TYPE_CS  Counter-Strike. GS_TYPE_CSCZ  Counter-Strike: Condition Zero. GS_TYPE_CALLOFDUTY  Call of Duty. GS_TYPE_SWJKJA  Star Wars Jedi Knight: Jedi Academy. GS_TYPE_MOHAA  Medal of Honor: Allied Assault. GS_TYPE_MOHBT  Medal of Honor: Breakthrough. GS_TYPE_MOHSH  Medal of Honor: Spearhead. GS_TYPE_DOD  Day of Defeat. GS_TYPE_SOF  Soldier of Fortune. GS_TYPE_GAMESPY  GameSpy Protocol. GS_TYPE_UT  Unreal Tournament. GS_TYPE_SWJK2  Star Wars Jedi Knight 2: Jedi Outcast. GS_TYPE_DESCENT3  Descent 3. GS_TYPE_AMERICASARMY  America's Army. GS_TYPE_BF1942  Battlefield 1942. GS_TYPE_HALO  Halo: Combat Evolved. GS_TYPE_POSTAL2  Postal 2. GS_TYPE_STVEF  Star Trek: Voyager - Elite Force. GS_TYPE_STVEF2  Star Trek: Voyager - Elite Force 2. GS_TYPE_DEUSEX  Deus Ex. GS_TYPE_IL2S  IL-2 Sturmovik. GS_TYPE_IL2SFB  IL-2 Sturmovik: Forgotten Battles. GS_TYPE_SOURCE  Source Engine. GS_TYPE_HALFLIFE2  Half-Life 2. GS_TYPE_CSS  Counter-Strike: Source. GS_TYPE_ASE  All-Seeing Eye Protocol. GS_TYPE_MTA  Multi Theft Auto. GS_TYPE_MTAVC  Multi Theft Auto: Vice City. GS_TYPE_HERETIC2  Heretic 2. GS_TYPE_IGI2  IGI-2: Covert Strike. GS_TYPE_GORE  Gore. GS_TYPE_VIETCONG  Vietcong. GS_TYPE_NWN  Neverwinter Nights. GS_TYPE_SERIOUSSAM  Serious Sam. GS_TYPE_SERIOUSSAM2  Serious Sam: The Second Encounter. GS_TYPE_AOE2  Age of Empires II. GS_TYPE_AOE2TC  Age of Empires II: The Conquerors. GS_TYPE_AVP2  Aliens vs Predator 2. GS_TYPE_CHASER  Chaser. GS_TYPE_CHROME  Chrome. GS_TYPE_NOLF  No One Lives Forever. GS_TYPE_NOLF2  No One Lives Forever 2. GS_TYPE_SHOGO  Shogo. GS_TYPE_SOLDAT  Soldat. GS_TYPE_CODENAMEEAGLE  Codename Eagle. GS_TYPE_DEVASTATION  Devastation. GS_TYPE_GIANTSCK  Giants: Citizen Kabuto. GS_TYPE_GLOBALOPS  Global Operations. GS_TYPE_NERFAB  Nerf Arena Blast. GS_TYPE_PURGEJIHAD  Purge Jihad. GS_TYPE_RSC  RalliSport Challenge. GS_TYPE_RALLYMASTERS  Rally Masters. GS_TYPE_CCRENEGADE  Command and Conquer: Renegade. GS_TYPE_RUNE  Rune. GS_TYPE_SIN  Sin. GS_TYPE_TACTICALOPS  Tactical Ops. GS_TYPE_UCOMBAT  Universal Combat. GS_TYPE_UNREAL  Unreal. GS_TYPE_WHEELOFTIME  Wheel of Time. GS_TYPE_XPANDRALLY  Xpand Rally. GS_TYPE_DDPT  Deadly Dozen: Pacific Theater. GS_TYPE_DTR2  Dirt Track Racing II. GS_TYPE_DRAKAN  Drakan: Order of the Flame. GS_TYPE_F12002  F1 2002. GS_TYPE_GUNMAN  Gunman Chronicles. GS_TYPE_IRONSTORM  Iron Storm. GS_TYPE_JBNF  James Bond: Nightfire. GS_TYPE_KINGPIN  Kingpin. GS_TYPE_NFSHP2  Need for Speed: Hot Pursuit 2. GS_TYPE_OPFLASHPOINT  Operation Flashpoint. GS_TYPE_REDLINE  Redline. GS_TYPE_TERMINUS  Terminus. GS_TYPE_TUROK2  Turok 2. GS_TYPE_TRON20  Tron 2.0. GS_TYPE_TRIBES  Starsiege: Tribes. GS_TYPE_TRIBES2  Tribes 2. GS_TYPE_THPS3  Tony Hawk's Pro Skater 3. GS_TYPE_THPS4  Tony Hawk's Pro Skater 4. GS_TYPE_V8SCC  V8 Supercar Challenge. GS_TYPE_TEAMFACTOR  Team Factor. GS_TYPE_RAINBOWSIX  Rainbow Six. GS_TYPE_RAINBOWSIXRS  Rainbow Six: Rogue Spear. GS_TYPE_NITRO  Nitro Family. GS_TYPE_FARCRY  Far Cry. GS_TYPE_RISEOFNATIONS  Rise of Nations. GS_TYPE_CONTRACTJACK  Contract J.A.C.K. GS_TYPE_HOMEWORLD2  Homeworld 2. GS_TYPE_DAIKATANA  Daikatana. GS_TYPE_SAVAGE  Savage. GS_TYPE_GHOSTRECON  Ghost Recon. GS_TYPE_BREED  Breed. GS_TYPE_MOHPA  Medal of Honor: Pacific Assault. GS_TYPE_OPFRESISTANCE  Operation Flashpoint: Resistance. GS_TYPE_SOAF  Sum of All Fears. GS_TYPE_STBC  Star Trek: Bridge Commander. GS_TYPE_CODUO  Call of Duty: United Offensive. GS_TYPE_SWBF  Star Wars: Battlefront. GS_TYPE_TRIBES3  Tribes: Vengeance.

---

Function Documentation

void GSFreeServerInfo (  GS_SERVERINFO *  info  )

Frees the status information returned by GSQueryServer(). Parameters: info  The status information to free.

GS_SERVERINFO* GSQueryServer (  unsigned short  type, const char *  host, unsigned short  port )

Queries a server for it's status information. Parameters: type  Describes the type of server to query. Must be one of the GS_TYPE_* enumerations. host  A string containing a valid hostname, IPv4, or IPv6 address. port  The port to contact the server on. If this is 0 GameStat will try to guess it for you. Returns: On success, status information for the server. On failure, NULL. To find out why, call GSLastError(). Note: port must be the server's query port, which is usually different from the game port. See also: GS_TYPE, GSFreeServerInfo()

char* GSStripColor (  unsigned short  type, char *  out, const char *  in )

Strips any color or formatting from a string. Parameters: type  Describes the type of server the string came from. Must be one of the GS_TYPE_* enumerations. out  Specifies the destination string. in  Specifies the input string. Returns: On success, a pointer to the new string. On failure, NULL. To find out why, call GSLastError(). Note: out can safely overlap in. If out == in, conversion is done in place. Since: 1.1 See also: GS_TYPE

---