group Strings

Description

Ferite strings provide a nice clean method for encoding and storing strings, and managing binary data. The functions below provide several means of string mangement which makes twiddling 'string' variables easier.

group attributes ferite_str_new() - Create a new string with exisitng data and encoding ferite_str_dup() - Duplicate a ferite string ferite_str_set() - Set the data contained within an existing string ferite_str_destroy() - Destroy the string and free all memory ferite_str_cmp() - Compare two strings ferite_str_case_cmp() - Compare two strings but dont take into consideration what case the strings are ferite_str_ncmp() - Compare two strings upto a certain size ferite_str_case_ncmp() - Compare two strings upto a certain size without considering the case of the strings ferite_str_cpy() - Copy the contents of the second string to the first string ferite_str_ncpy() - Copy the contents of the second string to the first string upto size character ferite_str_cat() - Concatenate the second string onto the first ferite_str_data_cat() - Concatenate the data onto the first string ferite_str_replace() - Replace all occurances of a string with another

Functions

function ferite_str_new Create a new string with exisitng data and encoding Declaration:     FeriteString *ferite_str_new( char *str, int length, int encoding ) Parameters:     Parameter #1: char *str - The data to use     Parameter #2: int length - The length of the data, if it is 0, strlen() is called on the data.     Parameter #3: int encoding - The encoding to use, if you are not sure use FE_CHARSET_DEFAULT Returns:     A FeriteString containing the data

function ferite_str_dup Duplicate a ferite string Declaration:     FeriteString *ferite_str_dup( FeriteString *str ) Parameters:     Parameter #1: FeriteString *str - The string to duplicate Returns:     A new string

function ferite_str_set Set the data contained within an existing string Declaration:     void ferite_str_set( FeriteString *str, char *data, int length, int encoding ) Parameters:     Parameter #1: FeriteString *str - The string to set     Parameter #2: char *data - The data to use     Parameter #3: int length - The length of the data     Parameter #4: int encoding - The encoding of the data, for a default use FE_CHARSET_DEFAULT

function ferite_str_destroy Destroy the string and free all memory Declaration:     void ferite_str_destroy( FeriteString *str ) Parameters:     Parameter #1: FeriteString *str - The string to destroy

function ferite_str_cmp Compare two strings Declaration:     int ferite_str_cmp( FeriteString *str1, FeriteString *str2 ) Parameters:     Parameter #1: FeriteString *str1 - The first string     Parameter #2: FeriteString *str2 - The second string Returns:     1 if they match, 0 if they dont

function ferite_str_case_cmp Compare two strings but dont take into consideration what case the strings are Declaration:     int ferite_str_case_cmp( FeriteString *str1, FeriteString *str2 ) Parameters:     Parameter #1: FeriteString *str1 - The first string     Parameter #2: FeriteString *str2 - The second string Returns:     1 if they match, 0 if they dont

function ferite_str_ncmp Compare two strings upto a certain size Declaration:     int ferite_str_ncmp( FeriteString *str1, FeriteString *str2, int size ) Parameters:     Parameter #1: FeriteString *str1 - The first string     Parameter #2: FeriteString *str2 - The second string     Parameter #3: int size - The size upto which the strings should be compared Returns:     1 if they match, 0 if they dont

function ferite_str_case_ncmp Compare two strings upto a certain size without considering the case of the strings Declaration:     int ferite_str_case_ncmp( FeriteString *str1, FeriteString *str2, int size ) Parameters:     Parameter #1: FeriteString *str1 - The first string     Parameter #2: FeriteString *str2 - The second string     Parameter #3: int size - The size upto which the strings should be compared Returns:     1 if they match, 0 if they dont

function ferite_str_cpy Copy the contents of the second string to the first string Declaration:     int ferite_str_cpy( FeriteString *str1, FeriteString *str2 ) Parameters:     Parameter #1: FeriteString *str1 - The first string     Parameter #2: FeriteString *str2 - The second string Returns:     The amount of data copied

function ferite_str_ncpy Copy the contents of the second string to the first string upto size character Declaration:     int ferite_str_ncpy( FeriteString *str1, FeriteString *str2, int size ) Parameters:     Parameter #1: FeriteString *str1 - The first string     Parameter #2: FeriteString *str2 - The second string     Parameter #3: int size - The amount of data to copy Returns:     The amount of data copied

function ferite_str_cat Concatenate the second string onto the first Declaration:     int ferite_str_cat( FeriteString *str1, FeriteString *str2 ) Parameters:     Parameter #1: FeriteString *str1 - The first string     Parameter #2: FeriteString *str2 - The second string

function ferite_str_data_cat Concatenate the data onto the first string Declaration:     int ferite_str_data_cat( FeriteString *str1, void *data, int size ) Parameters:     Parameter #1: FeriteString *str1 - The first string     Parameter #2: void *data - The data to concatenate     Parameter #3: int size - The length of the data to concatenate

function ferite_str_replace Replace all occurances of a string with another Declaration:     FeriteString *ferite_str_replace( FeriteString *str, FeriteString *what, FeriteString *with ) Parameters:     Parameter #1: FeriteString *str - The string to scane     Parameter #2: FeriteString *what - The string to scan for     Parameter #3: FeriteString *with - The string to replace 'what' with Returns:     A new string with the replacements

Automatically generated at 8:45pm, Wednesday 08 January 2003 by feritedoc.