---

lfc::win32PAL::console Namespace Reference

win32 console PAL. More...

Enumerations
enum	ErrorCodes { errOk }
Functions
int	init ()
	init console PAL. More...
int	cleanup ()
	cleanup console PAL. More...
int	putChar (int value)
	send a character to console. More...
int	getChar (int &value)
	read a character from console. More...
int	flush ()
	flush console output buffer. More...
const char *	message (int index)
	return the message coresponding to a return code. More...
Variables
const int	MAX_ERROR_CODE = 0
const char *	messagesTable [MAX_ERROR_CODE+1]

---

Detailed Description

win32 console PAL.

Todo:

need testing

---

Enumeration Type Documentation

enum lfc::win32PAL::console::ErrorCodes

Enumeration values: errOk

---

Function Documentation

int init (    )  [inline]

init console PAL. Returns: error code (0 means no error)

int cleanup (    )  [inline]

cleanup console PAL. Returns: error code (0 means no error)

int putChar (  int    value )  [inline]

send a character to console. Parameters: value  character code Returns: error code (0 means no error)

int getChar (  int &    value )  [inline]

read a character from console. Parameters: value  returned character code Returns: error code (0 means no error)

int flush (    )  [inline]

flush console output buffer. Returns: error code (0 means no error)

const char* message (  int    index )  [inline]

return the message coresponding to a return code. Parameters: index  message index (return code from other pal functions)

---

Variable Documentation

const int lfc::win32PAL::console::MAX_ERROR_CODE = 0

const char * lfc::win32PAL::console::messagesTable

Initial value: { "win32PAL::console -- No error (ok)", }

---