Main Page | Modules | Data Structures | File List | Data Fields | Globals

Library Setup


Enumerations

enum  GS_INITFLAGS { GS_INIT_NONE = 0, GS_INIT_WINSOCK = 1 }
 Initialization flags. More...
enum  GS_CLEANUPFLAGS { GS_CLEANUP_NONE = 0, GS_CLEANUP_WINSOCK = 1 }
 Cleanup flags. More...

Functions

unsigned char GSInit (unsigned char flags)
 Initializes GameStat.
unsigned char GSCleanup (unsigned char flags)
 Cleans up GameStat.
unsigned short GSVersion (void)
 Retrieves the current library version.

Enumeration Type Documentation

enum GS_CLEANUPFLAGS
 

Cleanup flags.

Enumeration values:
GS_CLEANUP_NONE  Don't cleanup anything.
GS_CLEANUP_WINSOCK  Cleanup Windows Sockets. Does nothing on non-Windows platforms.

enum GS_INITFLAGS
 

Initialization flags.

Enumeration values:
GS_INIT_NONE  Don't initialize anything.
GS_INIT_WINSOCK  Initialize Windows Sockets. Does nothing on non-Windows platforms.


Function Documentation

unsigned char GSCleanup unsigned char  flags  ) 
 

Cleans up GameStat.

Parameters:
flags Cleans up any libraries or internal structures GameStat depends on. Must be one of the GS_CLEANUP_* enumerations.
Returns:
GS_TRUE on success, GS_FALSE on error. To find out why, call GSLastError().
See also:
GS_CLEANUPFLAGS

unsigned char GSInit unsigned char  flags  ) 
 

Initializes GameStat.

Parameters:
flags Initializes any libraries or internal structures GameStat depends on. Must be one of the GS_INIT_* enumerations.
Returns:
GS_TRUE on success, GS_FALSE on error. To find out why, call GSLastError().
See also:
GS_INITFLAGS, GSCleanup()

unsigned short GSVersion void   ) 
 

Retrieves the current library version.

Low byte contains the major version, High byte contains the minor version.

Returns:
Library version


Generated on Wed Oct 6 01:04:06 2004 for GameStat by  doxygen 1.3.9