WsbTypes.h File Reference

Wasabi Result. More...

#include "WsbConfig.h"

Go to the source code of this file.

Data Structures
struct	WSB_DateTime
	A date and time. More...
struct	WSB_TimeCode
	A timecode suitable for media stream position. More...
struct	WSB_StreamPosition
struct	WSB_StreamInfo
struct	WSB_ByteArray
	An untyped array of bytes. More...
#define	NULL   ((void*) 0)
enum	WSB_Boolean {   WSB_FALSE = 0,   WSB_TRUE = 1 }
	Boolean type used for variables that can be true (WSB_TRUE) or false (WSB_FALSE). More...
typedef unsigned int	WSB_UInt32
	32-bit (or more) unsigned integer More...
typedef signed int	WSB_Int32
	32-bit (or more) signed integer More...
typedef unsigned short	WSB_UInt16
	16-bit unsigned integer More...
typedef signed short	WSB_Int16
	16-bit signed integer More...
typedef unsigned char	WSB_UInt8
	8-bit unsigned integer More...
typedef signed char	WSB_Int8
	8-bit signed integer More...
typedef float	WSB_Float
	IEEE float. More...
typedef WSB_CONFIG_INT64_TYPE	WSB_Int64
typedef unsigned WSB_CONFIG_INT64_TYPE	WSB_UInt64
typedef unsigned WSB_CONFIG_INT64_TYPE	WSB_LargeSize
typedef unsigned WSB_CONFIG_INT64_TYPE	WSB_Position
typedef int	WSB_Result
	Signed integer value representing a function or method result (return value). More...
typedef WSB_UInt32	WSB_Flags
	Type used to represent a bit pattern signifying a combination of flags that can be on or off. More...
typedef WSB_UInt32	WSB_Mask
	An unsigned integer used to represent a bit mask. More...
typedef WSB_UInt32	WSB_Size
	An unsigned integer used to represent a measurable quantity (e.g., the size of a file). More...
typedef WSB_Int32	WSB_Offset
	A signed integer used to represent an offset from a base position value. More...
typedef WSB_UInt32	WSB_Range
	An unsigned integer used to represent the difference between a maximum value and a minimum value. More...
typedef WSB_UInt32	WSB_Cardinal
	An unsigned integer used to represent a quantity that can be counted (such as a number of elements in a list). More...
typedef WSB_UInt32	WSB_Ordinal
	An unsigned integer that represents a position in a sequence (such as an index into a list of elements). More...
typedef WSB_UInt8	WSB_Byte
	An 8-bit byte. More...

Detailed Description

Wasabi Result.

Macro Definition Documentation

NULL

#define NULL   ((void*) 0)

Typedef Documentation

WSB_Byte

typedef WSB_UInt8 WSB_Byte

An 8-bit byte.

WSB_Cardinal

typedef WSB_UInt32 WSB_Cardinal

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

WSB_Flags

typedef WSB_UInt32 WSB_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.

WSB_Float

typedef float WSB_Float

IEEE float.

WSB_Int16

typedef signed short WSB_Int16

16-bit signed integer

WSB_Int32

typedef signed int WSB_Int32

32-bit (or more) signed integer

WSB_Int64

typedef WSB_CONFIG_INT64_TYPE WSB_Int64

WSB_Int8

typedef signed char WSB_Int8

8-bit signed integer

WSB_LargeSize

typedef unsigned WSB_CONFIG_INT64_TYPE WSB_LargeSize

WSB_Mask

typedef WSB_UInt32 WSB_Mask

An unsigned integer used to represent a bit mask.

WSB_Offset

typedef WSB_Int32 WSB_Offset

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

WSB_Ordinal

typedef WSB_UInt32 WSB_Ordinal

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

WSB_Position

typedef unsigned WSB_CONFIG_INT64_TYPE WSB_Position

WSB_Range

typedef WSB_UInt32 WSB_Range

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

WSB_Result

typedef int WSB_Result

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

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

WSB_Size

typedef WSB_UInt32 WSB_Size

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

WSB_UInt16

typedef unsigned short WSB_UInt16

16-bit unsigned integer

WSB_UInt32

typedef unsigned int WSB_UInt32

32-bit (or more) unsigned integer

WSB_UInt64

typedef unsigned WSB_CONFIG_INT64_TYPE WSB_UInt64

WSB_UInt8

typedef unsigned char WSB_UInt8

8-bit unsigned integer

Enumeration Type Documentation

WSB_Boolean

enum WSB_Boolean

Boolean type used for variables that can be true (WSB_TRUE) or false (WSB_FALSE).

Enumerator
WSB_FALSE
WSB_TRUE