ShiTypes.h File Reference

Common data types. More...

Go to the source code of this file.

Data Structures
struct	SHI_DateTime
	A date and time. More...
struct	SHI_ByteArray
	An untyped array of bytes. More...

Macros
#define	NULL   ((void*) 0)
#define	SHI_PUBLIC_API

Typedefs
typedef unsigned int	SHI_UInt32
	32-bit (or more) unsigned integer More...
typedef signed int	SHI_Int32
	32-bit (or more) signed integer More...
typedef unsigned short	SHI_UInt16
	16-bit unsigned integer More...
typedef signed short	SHI_Int16
	16-bit signed integer More...
typedef unsigned char	SHI_UInt8
	8-bit unsigned integer More...
typedef signed char	SHI_Int8
	8-bit signed integer More...
typedef float	SHI_Float
	IEEE float. More...
typedef int	SHI_Result
	Signed integer value representing a function or method result (return value). More...
typedef SHI_UInt32	SHI_Flags
	Type used to represent a bit pattern signifying a combination of flags that can be on or off. More...
typedef SHI_UInt32	SHI_Mask
	An unsigned integer used to represent a bit mask. More...
typedef SHI_UInt32	SHI_Size
	An unsigned integer used to represent a measurable quantity (e.g., the size of a file). More...
typedef SHI_Int32	SHI_Offset
	A signed integer used to represent an offset from a base position value. More...
typedef SHI_UInt32	SHI_Range
	An unsigned integer used to represent the difference between a maximum value and a minimum value. More...
typedef SHI_UInt32	SHI_Cardinal
	An unsigned integer used to represent a quantity that can be counted (such as a number of elements in a list). More...
typedef SHI_UInt32	SHI_Ordinal
	An unsigned integer that represents a position in a sequence (such as an index into a list of elements). More...
typedef SHI_UInt8	SHI_Byte
	An 8-bit byte. More...

Enumerations
enum	SHI_Boolean {   SHI_FALSE = 0,   SHI_TRUE = 1 }
	Boolean type used for variables that can be true (SHI_TRUE) or false (SHI_FALSE). More...

Detailed Description

Common data types.

Macro Definition Documentation

NULL

#define NULL   ((void*) 0)

SHI_PUBLIC_API

#define SHI_PUBLIC_API

Typedef Documentation

SHI_Byte

typedef SHI_UInt8 SHI_Byte

An 8-bit byte.

SHI_Cardinal

typedef SHI_UInt32 SHI_Cardinal

An unsigned integer used to represent a quantity that can be counted (such as a number of elements in a list).

SHI_Flags

typedef SHI_UInt32 SHI_Flags

Type used to represent a bit pattern signifying a combination of flags that can be on or off.

Bits set to 1 indicate that the corresponding flag is on, bits set to 0 indicate that the corresponding flag is off. The position and meaning of flags is specific to each method, function, variable or data structure that uses this type, and the corresponding header file specifies symbolic constants to represent individual flag bits.

SHI_Float

typedef float SHI_Float

IEEE float.

SHI_Int16

typedef signed short SHI_Int16

16-bit signed integer

SHI_Int32

typedef signed int SHI_Int32

32-bit (or more) signed integer

SHI_Int8

typedef signed char SHI_Int8

8-bit signed integer

SHI_Mask

typedef SHI_UInt32 SHI_Mask

An unsigned integer used to represent a bit mask.

SHI_Offset

typedef SHI_Int32 SHI_Offset

A signed integer used to represent an offset from a base position value.

SHI_Ordinal

typedef SHI_UInt32 SHI_Ordinal

An unsigned integer that represents a position in a sequence (such as an index into a list of elements).

SHI_Range

typedef SHI_UInt32 SHI_Range

An unsigned integer used to represent the difference between a maximum value and a minimum value.

SHI_Result

typedef int SHI_Result

Signed integer value representing a function or method result (return value).

When a function or method call succeeds, the return value is always SHI_SUCCESS unless otherwise documented. Error conditions are always negative values, defined in ShiResults.h.

SHI_Size

typedef SHI_UInt32 SHI_Size

An unsigned integer used to represent a measurable quantity (e.g., the size of a file).

SHI_UInt16

typedef unsigned short SHI_UInt16

16-bit unsigned integer

SHI_UInt32

typedef unsigned int SHI_UInt32

32-bit (or more) unsigned integer

SHI_UInt8

typedef unsigned char SHI_UInt8

8-bit unsigned integer

Enumeration Type Documentation

SHI_Boolean

enum SHI_Boolean

Boolean type used for variables that can be true (SHI_TRUE) or false (SHI_FALSE).

Enumerator
SHI_FALSE
SHI_TRUE