Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Related Pages

str: Dynamically allocated string library.


Data Structures

struct  str
 The basic string structure. More...
struct  str_sortentry
 This struct is used to serve in lists of pointers into a string for sorting. More...

Defines

#define STR_BLOCKSIZE   16

Typedefs

typedef str str
typedef str_sortentry str_sortentry

Detailed Description

Calling Convention
The standard calling convention to str functions is to pass the string being examined or modified as the first argument. For most functions, the return value will be 0 (false) if an error occurred (ie memory allocation failed) and non-zero (true) otherwise.

Define Documentation

#define STR_BLOCKSIZE   16
 

The block size in which string memory is allocated.

STR_BLOCKSIZE should be set to at least the size at which the allocator (ie malloc) will align the data it returns. String data will be allocated in steps of this number. Values smaller than the alignment will only cause a small amount of space to be wasted, and will not trigger bugs.


Typedef Documentation

typedef struct str str
 

String structure typedef.

typedef struct str_sortentry str_sortentry
 

String sort entry typedef.


Generated on Fri Dec 2 00:10:24 2005 for bglibs by  doxygen 1.4.4