ajresourcewrite.c

Datatypes: AjPOutfile none

Datatype: AjPOutfile

Data resource data output

Sections: data resource data outputs

Section: data resource data outputs

These functions write the data resource data provided by the first argument

Functions: ajResourceoutWrite

Function ajResourceoutWrite

Write a data resource in a named format

Synopsis

Prototype
AjBool ajResourceoutWrite (
      AjPOutfile outf,
      const AjPResource resource
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPResourceresourceInputData resource object
AjBool RETURNTrue on success

Input
resource:(Input)Data resource object
Input & Output
outf:(Modify)Output file
Returns
AjBool:True on success

Description

Write a data resource in a named format

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: none

Miscellaneous functions

Sections: Print Miscellaneous

Section: Print

Printing to a file

Functions: ajResourceoutprintBook ajResourceoutprintHtml ajResourceoutprintText ajResourceoutprintWiki

Function ajResourceoutprintBook

Reports the resource format internals as Docbook text

Synopsis

Prototype
void ajResourceoutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the resource format internals as Docbook text

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceoutprintHtml

Reports the internal data structures

Synopsis

Prototype
void ajResourceoutprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceoutprintText

Reports the internal data structures

Synopsis

Prototype
void ajResourceoutprintText (
      AjPFile outf,
      AjBool full
);

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

Input
full:(Input)Full report (usually ajFalse)
Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceoutprintWiki

Reports the data resource output format internals as wikitext

Synopsis

Prototype
void ajResourceoutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the data resource output format internals as wikitext

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Miscellaneous

Functions to initialise and clean up internals

Functions: ajResourceoutExit

Function ajResourceoutExit

Cleans up data output internal memory

Synopsis

Prototype
void ajResourceoutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up data output internal memory

See Also

See other functions in this section

Availability

In release 6.4.0

Section: cast

Values for output formats

Functions: ajResourceoutformatFind ajResourceoutformatTest

Function ajResourceoutformatFind

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

Sets iformat as the recognised format, and returns ajTrue.

Synopsis

Prototype
AjBool ajResourceoutformatFind (
      const AjPStr format,
      ajint* iformat
);

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

Input
format:(Input)Format required.
Output
iformat:(Output)Index
Returns
AjBool:ajTrue on success.

Description

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

Sets iformat as the recognised format, and returns ajTrue.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceoutformatTest

Tests whether a named data resource output format is known

Synopsis

Prototype
AjBool ajResourceoutformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if formats was accepted

Input
format:(Input)Format
Returns
AjBool:ajTrue if formats was accepted

Description

Tests whether a named data resource output format is known

See Also

See other functions in this section

Availability

In release 6.4.0