ajxmlwrite.c

Datatypes:
AjPOutfile Xml data output
none Miscellaneous functions


Datatype: AjPOutfile

Function is for manipulating xml data objects

Sections:
xml data outputsOutput


AjPOutfile: xml data outputs

These functions write the xml data provided by the first argument

Functions:
ajXmloutWriteWrite xml data in a named format


Function ajXmloutWrite

Write xml data in a named format

Prototype

AjBool ajXmloutWrite (
      AjPOutfile outf,
      const AjPXml xml
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPXmlxmlInputXml data object
AjBool RETURNTrue on success

In release 6.5.0


Datatype: none

Functions to initialise and clean up internals

Sections:
PrintCasts


Section: Print

Printing to a file

Functions:
ajXmloutprintBookReports the xml format internals as Docbook text
ajXmloutprintHtmlReports the internal data structures
ajXmloutprintTextReports the internal data structures
ajXmloutprintWikiReports the xml output format internals as wikitext


Function ajXmloutprintBook

Reports the xml format internals as Docbook text

Prototype

void ajXmloutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

In release 6.5.0


Function ajXmloutprintHtml

Reports the internal data structures

Prototype

void ajXmloutprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

In release 6.5.0


Function ajXmloutprintText

Reports the internal data structures

Prototype

void ajXmloutprintText (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull report (usually ajFalse)
void RETURN

In release 6.5.0


Function ajXmloutprintWiki

Reports the xml output format internals as wikitext

Prototype

void ajXmloutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

In release 6.5.0


Section: cast

Values for output formats

Functions:
ajXmloutformatFindLooks for the specified format(s) in the internal definitions and returns the index.
ajXmloutformatTestTests whether a named xml output format is known


Function ajXmloutformatFind

Looks for the specified format(s) in the internal definitions and returns the index.

Prototype

AjBool ajXmloutformatFind (
      const AjPStr format,
      ajint* iformat
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat required.
ajint*iformatOutputIndex
AjBool RETURNajTrue on success.

In release 6.5.0


Function ajXmloutformatTest

Tests whether a named xml output format is known

Prototype

AjBool ajXmloutformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if formats was accepted

In release 6.5.0


Section: Miscellaneous

Functions to initialise and clean up internals

Functions:
ajXmloutExitCleans up xml output internal memory


Function ajXmloutExit

Cleans up xml output internal memory

Prototype

void ajXmloutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

In release 6.5.0