debian man page for firestring_estr_xml_encode

firestring_estr_xml_encode(3)				     Library Functions Manual				     firestring_estr_xml_encode(3)

NAME
       firestring_estr_xml_encode - encode an estring into another estring for transmission inside XML data

SYNOPSIS
       #include <firestring.h>
       -lfirestring

       int firestring_estr_xml_encode(struct firestring_estr_t *destination, struct firestring_estr_t *source)

DESCRIPTION
       firestring_estr_xml_encode() encodes the contents of source by escaping characters that might trigger XML processing into destination, pro-
       vided that there is room in destination.  The minimum required space in destination is the length of source * 6.

RETURN VALUE
       0 if the string was encoded successfully; 1 if there was insufficient space in destination for the encoding to occur.

AUTHOR
       Ian Gulliver <ian@penguinhosting.net>

SEE ALSO
       libfirestring(3)

								    2002-09-21					     firestring_estr_xml_encode(3)