idrsstd_interface.h File Reference

Interface for idrsstd wrapper. More...

Go to the source code of this file.

Classes
struct	IDRS_RECT
	Structure that defines the upper-left and lower-right corners of a rectangle. More...
struct	IDRS_POINT
	Structure defines the coordinates of a point in iDRS. More...
struct	IDRS_COLOR
	Structure defines a color with Red, Green and Blue components. More...

Macros
#define	IDRS_FALSE   0
	false.
#define	IDRS_TRUE   1
	true.
#define	IDRS_MAX_PATH   260
	The maximum lenth for a path.

Typedefs
typedef unsigned char	IDRS_BYTE
	A byte.
typedef IDRS_BYTE *	IDRS_PBYTE
	Pointer to a byte.
typedef char	IDRS_CHAR
	A signed char.
typedef unsigned char	IDRS_UCHAR
	An unsigned char.
typedef unsigned int	IDRS_WCHAR32
	An UTF-32 unicode character.
typedef int	IDRS_INT
	A signed integer.
typedef unsigned int	IDRS_UINT
	An unsigned integer.
typedef unsigned int	IDRS_UINT32
	An unsigned integer on 32 bits.
typedef long long	IDRS_INT64
	An signed 64 bit value.
typedef unsigned long long	IDRS_UINT64
	An unsigned 64 bit value.
typedef double	IDRS_DOUBLE
	A double float value.
typedef IDRS_INT	IDRS_BOOL
	A Boolean value.
typedef IDRS_CHAR *	IDRS_STR
	A string.
typedef const IDRS_CHAR *	IDRS_CSTR
	A constant string.
typedef FILE *	IDRS_FILE
	A file pointer.
typedef void *	IDRS_PVOID
	A void pointer.
typedef const void *	IDRS_CPVOID
	A constant void pointer.

Enumerations
enum	IDRS_SEEK_POSITION { IDRS_SEEK_POSITION_BEGIN = 0 , IDRS_SEEK_POSITION_CURRENT = 1 , IDRS_SEEK_POSITION_END = 2 }
	The IDRS_SEEK_POSITION data type defines the initial position for a seek operation in a stream. More...

Functions
int	IsNullObject (struct idrsObject *ptr)

Detailed Description

Interface for idrsstd wrapper.

Enumeration Type Documentation

IDRS_SEEK_POSITION

enum IDRS_SEEK_POSITION

The IDRS_SEEK_POSITION data type defines the initial position for a seek operation in a stream.

The iDRS initial position for the seek operations. The iDRS defines 3 initial positions for a seek operation in a stream:

• beginning
• current position
• end

Enumerator
IDRS_SEEK_POSITION_BEGIN	Seek from the beginning. (The origin is the beginning of the stream)
IDRS_SEEK_POSITION_CURRENT	Seek from the current position. (The origin is the current position in the stream)
IDRS_SEEK_POSITION_END	Seek from the end. (The origin is the end of the stream)

Function Documentation

IsNullObject()

int IsNullObject

(

struct idrsObject *

ptr

)

Helper method used to verify if an object in C++ layer contains null data or not.