ajtextwrite.c

Datatypes:
AjPFile Text data output
none Miscellaneous functions


Datatype: AjPFile

Function is for manipulating text data objects

Sections:
text data outputsOutput


AjPFile: text data outputs

These functions write the text data provided by the first argument

Functions:
ajTextoutWriteWrite a text in a named format


Function ajTextoutWrite

Write a text in a named format

Prototype

AjBool ajTextoutWrite (
      AjPOutfile outf,
      const AjPText text
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPTexttextInputText object
AjBool RETURNTrue on success

From EMBOSS 6.4.0


Datatype: none

Functions to initialise and clean up internals

Sections:
PrintCasts


Section: Print

Printing to a file

Functions:
ajTextoutprintBookReports the text format internals as Docbook text
ajTextoutprintHtmlReports the internal data structures
ajTextoutprintTextReports the internal data structures
ajTextoutprintWikiReports the text output format internals as wikitext


Function ajTextoutprintBook

Reports the text format internals as Docbook text

Prototype

void ajTextoutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajTextoutprintHtml

Reports the internal data structures

Prototype

void ajTextoutprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajTextoutprintText

Reports the internal data structures

Prototype

void ajTextoutprintText (
      AjPFile outf,
      AjBool full
);

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

From EMBOSS 6.4.0


Function ajTextoutprintWiki

Reports the text output format internals as wikitext

Prototype

void ajTextoutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Section: cast

Values for output formats

Functions:
ajTextoutformatFindLooks for the specified format(s) in the internal definitions and returns the index.
ajTextoutformatTestTests whether a named text output format is known


Function ajTextoutformatFind

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

Prototype

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

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

From EMBOSS 6.4.0


Function ajTextoutformatTest

Tests whether a named text output format is known

Prototype

AjBool ajTextoutformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if formats was accepted

From EMBOSS 6.4.0


Section: Miscellaneous

Functions to initialise and clean up internals

Functions:
ajTextoutExitCleans up text data output internal memory


Function ajTextoutExit

Cleans up text data output internal memory

Prototype

void ajTextoutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0