ajxml.c

Datatypes:

AjPXml	Xml data
none	Miscellaneous functions

Datatype: AjPXml

Sections:

constructors	Constructors
Xml data destructors	Destructors
Casts	Casts
xml data modifiers	Modifiers

AjPXml: constructors

Functions:

ajXmlNew

Xml data constructor

Function ajXmlNew

Prototype

AjPXml ajXmlNew (
      void
);

Type	Name	Read/Write	Description
AjPXml		RETURN	New object

In release 6.5.0

AjPXml: Xml data destructors

Functions:

ajXmlDel

Xml data destructor

Function ajXmlDel

Prototype

void ajXmlDel (
      AjPXml* Pxml
);

Type	Name	Read/Write	Description
AjPXml*	Pxml	Delete	Xml data object to delete
void		RETURN

In release 6.5.0

AjPXml: Casts

Functions:

ajXmlGetDb	Return the database name
ajXmlGetEntry	Return the full text
ajXmlGetId	Return the identifier
ajXmlGetQryC	Returns the query string of a xml data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.
ajXmlGetQryS	Returns the query string of a xml data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

Function ajXmlGetDb

Prototype

const AjPStr ajXmlGetDb (
      const AjPXml xml
);

Type	Name	Read/Write	Description
const AjPXml	xml	Input	Xml
const AjPStr		RETURN	Database name

In release 6.5.0

Function ajXmlGetEntry

Prototype

const AjPStr ajXmlGetEntry (
      const AjPXml xml
);

Type	Name	Read/Write	Description
const AjPXml	xml	Input	XML entry
const AjPStr		RETURN	Returned full text

From EMBOSS 6.6.0

Function ajXmlGetId

Prototype

const AjPStr ajXmlGetId (
      const AjPXml xml
);

Type	Name	Read/Write	Description
const AjPXml	xml	Input	Xml
const AjPStr		RETURN	Returned id

In release 6.5.0

Function ajXmlGetQryC

Prototype

const char* ajXmlGetQryC (
      const AjPXml xml
);

Type	Name	Read/Write	Description
const AjPXml	xml	Input	Xml data object.
const char*		RETURN	Query as a character string.

In release 6.5.0

Function ajXmlGetQryS

Prototype

const AjPStr ajXmlGetQryS (
      const AjPXml xml
);

Type	Name	Read/Write	Description
const AjPXml	xml	Input	Xml data object.
const AjPStr		RETURN	Query as a string.

In release 6.5.0

AjPXml: xml data modifiers

Functions:

ajXmlClear

Resets all data for a xml data object so that it can be reused.

Function ajXmlClear

Prototype

void ajXmlClear (
      AjPXml xml
);

Type	Name	Read/Write	Description
AjPXml	xml	Modify	Xml data object
void		RETURN

In release 6.5.0

Datatype: none

Sections:

exit	Miscellaneous

Section: exit

Functions:

ajXmlExit

Cleans up xml processing internal memory

Function ajXmlExit

Prototype

void ajXmlExit (
      void
);

Type	Name	Read/Write	Description
void		RETURN

In release 6.5.0