Home| base |src.lib|xml|xmldb| EntityAddSymbolString Index

EntityAddSymbolString

Syntax
int EntityAddSymbolString(struct Entitydata *ptr,char *str);
Header
base/entity.h
Library
rxmldb
Description

The EntityAddSymbolString function adds the equivalent symbol for an entity (the text used to replace the entity) to an entity codec control structure.

The argument ptr points to the control structure. The text that defines the symbol is stored in the zero terminated string pointed to by the argument str.

An entity is often used as short hand for repeated text, to refer to symbols that would otherwise confuse the XML passer, such as "<" or ">", or to refer to external data.The entity codec encodes and decodes entity/symbol pairs.

Returns
Returns zero on success. On error, (-1) is returned.
Errors
On error (-1) is returned.
Example
None