.\" (C) 2002 Ian Gulliver
.TH firestring_estr_replace 3 2003-07-21
.SH NAME
firestring_estr_replace \-
Replace occurences of one string with another
.SH SYNOPSIS
.B #include <firestring.h>
.br
.B -lfirestring
.LP
.BI "int firestring_estr_replace(struct firestring_estr_t * const " dest ", const struct firestring_estr_t * const " source ", const struct firestring_estr_t * const " to ", const struct firestring_estr_t * const " from )
.SH DESCRIPTION
firestring_estr_replace() copies
.I source
into
.IR dest ,
replacing all instances from
.I from
with
.IR to .
If there is insufficient space in
.IR dest ,
the function returns 1 and the contents of
.I dest
are undefined.
.SH RETURN VALUE
0 if the replacement was successful; 1 if there was insufficient space in
.I destination
for the replacement to occur.
.SH AUTHOR
Ian Gulliver <ian@penguinhosting.net>
.SH SEE ALSO
.BR libfirestring (3)