KIM String Reference Documentation

Functions

Function Documentation

kim_error_t kim_string_copy (  kim_string_t *  out_string,
const kim_string_t  in_string
) 
 

Copy a string.

Parameters:
out_string on exit, a new string object which is a copy of in_string. Must be freed with kim_string_free().
in_string the string to copy.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_t kim_string_compare (  kim_string_t  in_string,
kim_string_t  in_compare_to_string,
kim_comparison_t *  out_comparison
) 
 

Compare two strings.

Parameters:
in_string a string.
in_compare_to_string a string to be compared to in_string.
out_comparison on exit, a comparison result indicating whether in_string is greater than, less than or equal to in_compare_to_string.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

void kim_string_free (  kim_string_t *  io_string  ) 
 

Free memory associated with a string.

Parameters:
io_string a string to be freed. Set to NULL on exit.