SPTypes.h File Reference

#include "SPConfig.h"
#include "AIBasicTypes.h"
#include "SPHeaderBegin.h"
#include "SPErrorCodes.h"
#include "SPHeaderEnd.h"

Go to the source code of this file.

Defines
#define	TRUE   true
	The basic declarations used by the PICA plug-in management suites.
#define	FALSE   false
#define	SPAPI
#define	SPAPI
Typedefs
typedef unsigned char	SPBoolean
	On Mac OS, SPBoolean is Boolean.
typedef signed long	SPInt32
typedef ai::int32	SPErr
	PICA error codes are C strings, except for the no-error code, which is NULL (and kSPOutOfMemoryError).

---

Define Documentation

#define FALSE   false

#define SPAPI

#define SPAPI

#define TRUE   true

The basic declarations used by the PICA plug-in management suites.

---

Typedef Documentation

typedef int SPBoolean

On Mac OS, SPBoolean is Boolean.

On Windows, SPBoolean is BOOL.

typedef ai::int32 SPErr

PICA error codes are C strings, except for the no-error code, which is NULL (and kSPOutOfMemoryError).

Compare errors first with kSPNoError, to text for success. On failure, compare with predefined error constants in SPErrorCodes.h.

For example:

 SPErr error = kSPNoError;
 block = SPAllocateBlock( size, debug, &error );
        if ( error != kSPNoError ) {
                if ( strcmp( error, kSPOutOfMemoryError ) == 0 )
                        FailOutOfMemory();
                        ...
                }

typedef signed long SPInt32