NAME¶

libcsplit.h — Library to support cross-platform C split string functions

SYNOPSIS¶

#include <libcsplit.h>

Support functions

const char *


libcsplit_get_version(
void);

Error functions

void


libcsplit_error_free(
libcsplit_error_t **error);

int


libcsplit_error_fprint(
libcsplit_error_t *error,
FILE *stream);

int


libcsplit_error_sprint(
libcsplit_error_t *error,
char *string,
size_t size);

int


libcsplit_error_backtrace_fprint(
libcsplit_error_t *error,
FILE *stream);

int


libcsplit_error_backtrace_sprint(
libcsplit_error_t *error,
char *string,
size_t size);

Narrow string functions

int


libcsplit_narrow_string_split(
const char *string,
size_t string_size,
char delimiter,
libcsplit_narrow_split_string_t **split_string,
libcsplit_error_t **error);

Narrow split string functions

int


libcsplit_narrow_split_string_free(
libcsplit_narrow_split_string_t **split_string,
libcsplit_error_t **error);

int


libcsplit_narrow_split_string_get_string(
libcsplit_narrow_split_string_t *split_string,
char **string,
size_t *string_size,
libcsplit_error_t **error);

int


libcsplit_narrow_split_string_get_number_of_segments(
libcsplit_narrow_split_string_t *split_string,
int *number_of_segments,
libcsplit_error_t **error);

int


libcsplit_narrow_split_string_get_segment_by_index(
libcsplit_narrow_split_string_t *split_string,
int segment_index,
char **string_segment,
size_t *string_segment_size,
libcsplit_error_t **error);

int


libcsplit_narrow_split_string_set_segment_by_index(
libcsplit_narrow_split_string_t *split_string,
int segment_index,
char *string_segment,
size_t string_segment_size,
libcsplit_error_t **error);

Wide string functions

int


libcsplit_wide_string_split(
const wchar_t *string,
size_t string_size,
wchar_t delimiter,
libcsplit_wide_split_string_t **split_string,
libcsplit_error_t **error);

Wide split string functions

int


libcsplit_wide_split_string_free(
libcsplit_wide_split_string_t **split_string,
libcsplit_error_t **error);

int


libcsplit_wide_split_string_get_string(
libcsplit_wide_split_string_t *split_string,
wchar_t **string,
size_t *string_size,
libcsplit_error_t **error);

int


libcsplit_wide_split_string_get_number_of_segments(
libcsplit_wide_split_string_t *split_string,
int *number_of_segments,
libcsplit_error_t **error);

int


libcsplit_wide_split_string_get_segment_by_index(
libcsplit_wide_split_string_t *split_string,
int segment_index,
wchar_t **string_segment,
size_t *string_segment_size,
libcsplit_error_t **error);

int


libcsplit_wide_split_string_set_segment_by_index(
libcsplit_wide_split_string_t *split_string,
int segment_index,
wchar_t *string_segment,
size_t string_segment_size,
libcsplit_error_t **error);

DESCRIPTION¶

The libcsplit_get_version() function is used to retrieve the library version.

RETURN VALUES¶

Most of the functions return NULL or -1 on error, dependent on the return type. For the actual return values see <libcsplit.h>.

ENVIRONMENT¶

None

FILES¶

None

NOTES¶

libcsplit can be compiled with wide character support (wchar_t).

To compile libcsplit with wide character support use: ./configure --enable-wide-character-type
or define: _UNICODE
or UNICODE
during compilation.

LIBCSPLIT_WIDE_CHARACTER_TYPE
in libcsplit/features.h can be used to determine if libcsplit was compiled with wide character support.

SEE ALSO¶

<libcsplit.h>

AUTHORS¶

Joachim Metz <joachim.metz@gmail.com>

BUGS¶

Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libcsplit/issues

COPYRIGHT¶

Copyright (C) 2008-2026, Joachim Metz <joachim.metz@gmail.com>.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.