Buffer

Functions
int	OGE_GetStaticBuf (int iIndex)
	Get static buffer by index.
int	OGE_ClearBuf (int iBufferId)
	Clear the buffer (zero all the bytes)
int	OGE_CopyBuf (int iFromId, int iToId, int iStart, int iLen)
	Copy a part from one buffer to another.
char	OGE_GetBufByte (int iBufId, int pos, int &next)
	Read a byte from the buffer.
int	OGE_GetBufInt (int iBufId, int pos, int &next)
	Read an integer from the buffer.
double	OGE_GetBufFloat (int iBufId, int pos, int &next)
	Read a floating-point value from the buffer.
string	OGE_GetBufStr (int iBufId, int pos, int len, int &next)
	Read a string from the buffer.
int	OGE_PutBufByte (int iBufId, int pos, char value)
	Write a byte into the buffer.
int	OGE_PutBufInt (int iBufId, int pos, int value)
	Write an integer into the buffer.
int	OGE_PutBufFloat (int iBufId, int pos, double value)
	Write a floating-point value into the buffer.
int	OGE_PutBufStr (int iBufId, int pos, string value)
	Write a string into the buffer.

---

Function Documentation

int OGE_ClearBuf

(

int

iBufferId

)

Clear the buffer (zero all the bytes)

Parameters:

[in]

iBufferId

The ID of the buffer

Returns:

Returns the size of the buffer

int OGE_CopyBuf	(	int	iFromId,
		int	iToId,
		int	iStart,
		int	iLen
	)

Copy a part from one buffer to another.

Parameters:

[in]	iFromId	The ID of the source buffer
[in]	iToId	The ID of the target buffer
[in]	iStart	The start position
[in]	iLen	The length of the part will be copied

Returns:

Returns the count of the bytes was copied

char OGE_GetBufByte	(	int	iBufId,
		int	pos,
		int &	next
	)

Read a byte from the buffer.

Parameters:

[in]	iBufId	The ID of the buffer
[in]	pos	Current reading position
[out]	next	Next reading position

Returns:

The value of the byte

double OGE_GetBufFloat	(	int	iBufId,
		int	pos,
		int &	next
	)

Read a floating-point value from the buffer.

Parameters:

[in]	iBufId	The ID of the buffer
[in]	pos	Current reading position
[out]	next	Next reading position

Returns:

The floating-point value

int OGE_GetBufInt	(	int	iBufId,
		int	pos,
		int &	next
	)

Read an integer from the buffer.

Parameters:

[in]	iBufId	The ID of the buffer
[in]	pos	Current reading position
[out]	next	Next reading position

Returns:

The value of the integer

string OGE_GetBufStr	(	int	iBufId,
		int	pos,
		int	len,
		int &	next
	)

Read a string from the buffer.

Parameters:

[in]	iBufId	The ID of the buffer
[in]	pos	Current reading position
[in]	len	The length of the string
[out]	next	Next reading position

Returns:

The string

int OGE_GetStaticBuf

(

int

iIndex

)

Get static buffer by index.

Parameters:

[in]

iIndex

The index if the static buffer

Returns:

The ID of the buffer

int OGE_PutBufByte	(	int	iBufId,
		int	pos,
		char	value
	)

Write a byte into the buffer.

Parameters:

[in]	iBufId	The ID of the buffer
[in]	pos	Current writing position
[in]	value	The value of the byte

Returns:

Next writing position

int OGE_PutBufFloat	(	int	iBufId,
		int	pos,
		double	value
	)

Write a floating-point value into the buffer.

Parameters:

[in]	iBufId	The ID of the buffer
[in]	pos	Current writing position
[in]	value	The floating-point value

Returns:

Next writing position

int OGE_PutBufInt	(	int	iBufId,
		int	pos,
		int	value
	)

Write an integer into the buffer.

Parameters:

[in]	iBufId	The ID of the buffer
[in]	pos	Current writing position
[in]	value	The value of the integer

Returns:

Next writing position

int OGE_PutBufStr	(	int	iBufId,
		int	pos,
		string	value
	)

Write a string into the buffer.

Parameters:

[in]	iBufId	The ID of the buffer
[in]	pos	Current writing position
[in]	value	The string

Returns:

Next writing position