Public API Reference

                 

---

iDataBuffer Struct Reference
[Utilities]

The iDataBuffer interface can be used to exchange buffers with abstract data between plugins. More...

#include <databuff.h>

Inheritance diagram for iDataBuffer:

List of all members.

Public Methods
virtual size_t	GetSize () const=0
	Query the buffer size. More...
virtual char *	GetData () const=0
	Get the buffer as an abstract pointer. More...
char *	operator * () const
	Get the buffer as an (char *) pointer. More...
int8 *	GetInt8 ()
	Get as an int8 *. More...
uint8 *	GetUint8 ()
	Get as an uint8 *. More...

---

Detailed Description

The iDataBuffer interface can be used to exchange buffers with abstract data between plugins.

The object does not care about the contents of the buffer; it just can perform several simple operations on them. The interface is designed to be light-weight, as an alternative to the heavy iString interface.

Definition at line 39 of file databuff.h.

---

Member Function Documentation

virtual char* iDataBuffer::GetData (    )  const [pure virtual]

Get the buffer as an abstract pointer. Implemented in csDataBuffer. Referenced by csDataBuffer::csDataBuffer, GetInt8, GetUint8, and operator *.

int8* iDataBuffer::GetInt8 (    )  [inline]

Get as an int8 *. Definition at line 49 of file databuff.h. References GetData, and int8.

virtual size_t iDataBuffer::GetSize (    )  const [pure virtual]

Query the buffer size. Implemented in csDataBuffer. Referenced by csDataBuffer::csDataBuffer.

uint8* iDataBuffer::GetUint8 (    )  [inline]

Get as an uint8 *. Definition at line 52 of file databuff.h. References GetData, and uint8.

char* iDataBuffer::operator * (    )  const [inline]

Get the buffer as an (char *) pointer. Definition at line 46 of file databuff.h. References GetData.

---

The documentation for this struct was generated from the following file:

• databuff.h

---