BT_Char8Buf_ Struct Reference

Data structure that encapsulates a buffer of 8-bit unsigned characters. More...

#include <bt_types.h>

Inheritance diagram for BT_Char8Buf_:

Inheritance graph
[legend]

List of all members.

Public Attributes

BT_Char8buf
 Pointer to BT_Char8 buffer.
BT_UInt32 len
 Length of the string.


Detailed Description

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.

The usage pattern for this structure is the following:

When passed to a function accepting data 'len' shall be the length of the data in the buffer. When passed to a function producing data 'len' shall be the length of the allocated space the function is permitted to fill, after the function call 'len' will be the length of the data produced.


Member Data Documentation

BT_Char8* BT_Char8Buf_::buf

Pointer to BT_Char8 buffer.

BT_UInt32 BT_Char8Buf_::len

Length of the string.


The documentation for this struct was generated from the following file:

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