ajvarwrite.c

Datatypes: AjPoutfile none

Datatype: AjPoutfile

Variation data output

Sections: variation data outputs

Section: variation data outputs

These functions write the variation data provided by the first argument

Functions: ajVaroutWrite

Function ajVaroutWrite

Write variation data in a named format

Synopsis

Prototype
AjBool ajVaroutWrite (
      AjPOutfile outf,
      const AjPVar var
);

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

Input
var:(Input)Variation object
Input & Output
outf:(Modify)Output file
Returns
AjBool:True on success

Description

Write variation data in a named format

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: none

Miscellaneous functions

Sections: Print

Section: Print

Printing to a file

Functions: ajVaroutprintBook ajVaroutprintHtml ajVaroutprintText ajVaroutprintWiki

Function ajVaroutprintBook

Reports the variation format internals as Docbook text

Synopsis

Prototype
void ajVaroutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

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

Description

Reports the variation format internals as Docbook text

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVaroutprintHtml

Reports the internal data structures

Synopsis

Prototype
void ajVaroutprintHtml (
      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 ajVaroutprintText

Reports the internal data structures

Synopsis

Prototype
void ajVaroutprintText (
      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 ajVaroutprintWiki

Reports the variation output format internals as wikitext

Synopsis

Prototype
void ajVaroutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

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

Description

Reports the variation output format internals as wikitext

See Also

See other functions in this section

Availability

In release 6.4.0

Section: cast

Values for output formats

Functions: ajVaroutformatFind ajVaroutformatTest

Function ajVaroutformatFind

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 ajVaroutformatFind (
      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 ajVaroutformatTest

Tests whether a named variation output format is known

Synopsis

Prototype
AjBool ajVaroutformatTest (
      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 variation output format is known

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Miscellaneous

Functions to initialise and clean up internals

Functions: ajVaroutExit

Function ajVaroutExit

Cleans up variation output internal memory

Synopsis

Prototype
void ajVaroutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up variation output internal memory

See Also

See other functions in this section

Availability

In release 6.4.0