ajurlwrite.c

Datatypes:
AjPOutfile Url data output
none Miscellaneous functions


Datatype: AjPOutfile

Function is for manipulating url data objects

Sections:
url data outputsOutput


AjPOutfile: url data outputs

These functions write the url data provided by the first argument

Functions:
ajUrloutWriteWrite url data in a named format


Function ajUrloutWrite

Write url data in a named format

Prototype

AjBool ajUrloutWrite (
      AjPOutfile outf,
      const AjPUrl url
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPUrlurlInputUrl data 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:
ajUrloutprintBookReports the url format internals as Docbook text
ajUrloutprintHtmlReports the internal data structures
ajUrloutprintTextReports the internal data structures
ajUrloutprintWikiReports the url output format internals as wikitext


Function ajUrloutprintBook

Reports the url format internals as Docbook text

Prototype

void ajUrloutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajUrloutprintHtml

Reports the internal data structures

Prototype

void ajUrloutprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajUrloutprintText

Reports the internal data structures

Prototype

void ajUrloutprintText (
      AjPFile outf,
      AjBool full
);

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

From EMBOSS 6.4.0


Function ajUrloutprintWiki

Reports the url output format internals as wikitext

Prototype

void ajUrloutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Section: cast

Values for output formats

Functions:
ajUrloutformatFindLooks for the specified format(s) in the internal definitions and returns the index.
ajUrloutformatTestTests whether a named URL output format is known


Function ajUrloutformatFind

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

Prototype

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

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

From EMBOSS 6.4.0


Function ajUrloutformatTest

Tests whether a named URL output format is known

Prototype

AjBool ajUrloutformatTest (
      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:
ajUrloutExitCleans up url output internal memory


Function ajUrloutExit

Cleans up url output internal memory

Prototype

void ajUrloutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0