Gnome XML Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# entities

## Name

entities —

## Synopsis

    #define     XML_INTERNAL_GENERAL_ENTITY
    #define     XML_EXTERNAL_GENERAL_PARSED_ENTITY
    #define     XML_EXTERNAL_GENERAL_UNPARSED_ENTITY
    #define     XML_INTERNAL_PARAMETER_ENTITY
    #define     XML_EXTERNAL_PARAMETER_ENTITY
    #define     XML_INTERNAL_PREDEFINED_ENTITY
    typedef     xmlEntityPtr;
    #define     XML_MIN_ENTITIES_TABLE
    typedef     xmlEntitiesTablePtr;
    void        xmlAddDocEntity                 (xmlDocPtr doc,
                                                 const xmlChar *name,
                                                 int type,
                                                 const xmlChar *ExternalID,
                                                 const xmlChar *SystemID,
                                                 const xmlChar *content);
    void        xmlAddDtdEntity                 (xmlDocPtr doc,
                                                 const xmlChar *name,
                                                 int type,
                                                 const xmlChar *ExternalID,
                                                 const xmlChar *SystemID,
                                                 const xmlChar *content);
    xmlEntityPtr xmlGetPredefinedEntity         (const xmlChar *name);
    xmlEntityPtr xmlGetDocEntity                (xmlDocPtr doc,
                                                 const xmlChar *name);
    xmlEntityPtr xmlGetDtdEntity                (xmlDocPtr doc,
                                                 const xmlChar *name);
    xmlEntityPtr xmlGetParameterEntity          (xmlDocPtr doc,
                                                 const xmlChar *name);
    const xmlChar* xmlEncodeEntities            (xmlDocPtr doc,
                                                 const xmlChar *input);
    xmlChar*    xmlEncodeEntitiesReentrant      (xmlDocPtr doc,
                                                 const xmlChar *input);
    xmlEntitiesTablePtr xmlCreateEntitiesTable  (void);
    xmlEntitiesTablePtr xmlCopyEntitiesTable    (xmlEntitiesTablePtr table);
    void        xmlFreeEntitiesTable            (xmlEntitiesTablePtr table);
    void        xmlDumpEntitiesTable            (xmlBufferPtr buf,
                                                 xmlEntitiesTablePtr table);
    void        xmlCleanupPredefinedEntities    (void);

## Description

## Details

### XML_INTERNAL_GENERAL_ENTITY

    #define     XML_INTERNAL_GENERAL_ENTITY

### XML_EXTERNAL_GENERAL_PARSED_ENTITY

    #define     XML_EXTERNAL_GENERAL_PARSED_ENTITY

### XML_EXTERNAL_GENERAL_UNPARSED_ENTITY

    #define     XML_EXTERNAL_GENERAL_UNPARSED_ENTITY

### XML_INTERNAL_PARAMETER_ENTITY

    #define     XML_INTERNAL_PARAMETER_ENTITY

### XML_EXTERNAL_PARAMETER_ENTITY

    #define     XML_EXTERNAL_PARAMETER_ENTITY

### XML_INTERNAL_PREDEFINED_ENTITY

    #define     XML_INTERNAL_PREDEFINED_ENTITY

### xmlEntityPtr

### XML_MIN_ENTITIES_TABLE

    #define     XML_MIN_ENTITIES_TABLE

### xmlEntitiesTablePtr

### xmlAddDocEntity ()

    void        xmlAddDocEntity                 (xmlDocPtr doc,
                                                 const xmlChar *name,
                                                 int type,
                                                 const xmlChar *ExternalID,
                                                 const xmlChar *SystemID,
                                                 const xmlChar *content);

Register a new entity for this document.

`doc` : |
`name` : |
`type` : |
`ExternalID` : |
`SystemID` : |
`content` : |

### xmlAddDtdEntity ()

    void        xmlAddDtdEntity                 (xmlDocPtr doc,
                                                 const xmlChar *name,
                                                 int type,
                                                 const xmlChar *ExternalID,
                                                 const xmlChar *SystemID,
                                                 const xmlChar *content);

Register a new entity for this document DTD.

`doc` : |
`name` : |
`type` : |
`ExternalID` : |
`SystemID` : |
`content` : |

### xmlGetPredefinedEntity ()

    xmlEntityPtr xmlGetPredefinedEntity         (const xmlChar *name);

Check whether this name is an predefined entity.

`name` : |
Returns : |

### xmlGetDocEntity ()

    xmlEntityPtr xmlGetDocEntity                (xmlDocPtr doc,
                                                 const xmlChar *name);

Do an entity lookup in the document entity hash table and returns the corrsponding entity, otherwise a lookup is done in the predefined entities too.

`doc` : |
`name` : |
Returns : |

### xmlGetDtdEntity ()

    xmlEntityPtr xmlGetDtdEntity                (xmlDocPtr doc,
                                                 const xmlChar *name);

Do an entity lookup in the Dtd entity hash table and returns the corresponding entity, if found.

`doc` : |
`name` : |
Returns : |

### xmlGetParameterEntity ()

    xmlEntityPtr xmlGetParameterEntity          (xmlDocPtr doc,
                                                 const xmlChar *name);

Do an entity lookup in the internal and external subsets and returns the corresponding parameter entity, if found.

`doc` : |
`name` : |
Returns : |

### xmlEncodeEntities ()

    const xmlChar* xmlEncodeEntities            (xmlDocPtr doc,
                                                 const xmlChar *input);

Do a global encoding of a string, replacing the predefined entities and non ASCII values with their entities and CharRef counterparts.

TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary compatibility

People must migrate their code to xmlEncodeEntitiesReentrant ! This routine will issue a warning when encountered.

`doc` : |
`input` : |
Returns : |

### xmlEncodeEntitiesReentrant ()

    xmlChar*    xmlEncodeEntitiesReentrant      (xmlDocPtr doc,
                                                 const xmlChar *input);

Do a global encoding of a string, replacing the predefined entities and non ASCII values with their entities and CharRef counterparts. Contrary to xmlEncodeEntities, this routine is reentrant, and result must be deallocated.

TODO !!!! Once moved to UTF-8 internal encoding, the encoding of non-ascii get erroneous.

`doc` : |
`input` : |
Returns : |

### xmlCreateEntitiesTable ()

    xmlEntitiesTablePtr xmlCreateEntitiesTable  (void);

create and initialize an empty entities hash table.

Returns : |

### xmlCopyEntitiesTable ()

    xmlEntitiesTablePtr xmlCopyEntitiesTable    (xmlEntitiesTablePtr table);

Build a copy of an entity table.

`table` : |
Returns : |

### xmlFreeEntitiesTable ()

    void        xmlFreeEntitiesTable            (xmlEntitiesTablePtr table);

Deallocate the memory used by an entities hash table.

`table` : |

### xmlDumpEntitiesTable ()

    void        xmlDumpEntitiesTable            (xmlBufferPtr buf,
                                                 xmlEntitiesTablePtr table);

This will dump the content of the entity table as an XML DTD definition

`buf` : |
`table` : |

### xmlCleanupPredefinedEntities ()

    void        xmlCleanupPredefinedEntities    (void);

Cleanup up the predefined entities table.

<<< Previous Page | Home | Up | Next Page >>>
tree | valid