bt_types.h File Reference

Fundamental type declarations. More...

#include "bt_utilities_internal.h"
#include "bt_comp.h"
#include "bt_result_codes.h"
#include <stddef.h>
#include <limits.h>

Include dependency graph for bt_types.h:

This graph shows which files directly or indirectly include this file:


Data Structures

struct  BT_Char16Buf_
 Data structure that encapsulates a buffer of 16-bit unsigned characters. More...
struct  BT_Char8Buf_
 Data structure that encapsulates a buffer of 8-bit unsigned characters. More...

Defines

#define false   0
 Value for boolean false.
#define true   1
 Value for boolean true.

Typedefs

typedef BT_UInt8 bool
 Boolean data type.
typedef BT_UInt16 BT_Char16
 16-bit unsigned character.
typedef struct BT_Char16Buf_ BT_Char16Buf
 Data structure that encapsulates a buffer of 16-bit unsigned characters.
typedef BT_UInt32 BT_Char32
 32-bit unsigned character.
typedef BT_UInt8 BT_Char8
 8-bit unsigned character.
typedef struct BT_Char8Buf_ BT_Char8Buf
 Data structure that encapsulates a buffer of 8-bit unsigned characters.
typedef const void * BT_ConstOpaquePtr
 Constant opaque pointer.
typedef BT_UInt32 BT_Enum
 (32-bit) enumerated values.
typedef signed short BT_Int16
 16-bit signed integer.
typedef signed int BT_Int32
 32-bit signed integer.
typedef signed char BT_Int8
 8-bit signed integer.
typedef BT_UInt32 BT_Mask
 (32-bit) bit mask.
typedef void BT_Opaque
 Opaque type value.
typedef void * BT_OpaquePtr
 Opaque pointer.
typedef signed int BT_Result
 Result type for SDK functions.
typedef unsigned short BT_UInt16
 16-bit unsigned integer.
typedef unsigned int BT_UInt32
 32-bit unsigned integer.
typedef unsigned char BT_UInt8
 8-bit unsigned integer.
typedef uintptr_t BT_UIntPtr
 Type for pointers to integer.

Detailed Description

This file contains fundamental type and macro declarations used by most Basis Technology SDKs.

Define Documentation

#define false   0

Value for boolean false

#define true   1

Value for boolean true


Typedef Documentation

typedef BT_UInt8 bool

Boolean data type, defined to compile C programs.

typedef BT_UInt16 BT_Char16

This type represents a 16-bit Unicode character encoded in UTF-16. The character is in the current platform's byte order.

typedef BT_UInt32 BT_Char32

This type represents a 32-bit Unicode character encoded in UTF-32. The character is in the current platform's byte order.

typedef BT_UInt8 BT_Char8

This type represents an 8-bit unsigned character, suitable for ASCII, UTF-8, or other multi-byte character type.

typedef struct BT_Char8Buf_ BT_Char8Buf

This structure includes a pointer to an 8-bit unsigned character, suitable for ASCII, UTF-8, or other multi-byte character type, and a length.

typedef signed int BT_Result

SDK function status is returned in a value of type BT_Result. Predefined common values are listed in bt_result_codes.h. Individual libraries can add their own result values in addition to the common set.


Copyright © 2004-2008 Basis Technology Corporation. All Rights Reserved.