ajtextwrite.c
Datatypes: AjPFile none
Text data output
Sections: text data outputs
These functions write the text data provided by the first argument
Functions: ajTextoutWrite
Write a text in a named format
Synopsis
Prototype
AjBool ajTextoutWrite (
AjPOutfile outf,
const AjPText text
);
| Type | Name | Read/Write | Description |
|---|
| AjPOutfile | outf | Modify | Output file |
| const AjPText | text | Input | Text object |
| AjBool | | RETURN | True on success |
Input
Input & Output
Returns
Description
Write a text in a named format
See Also
See other functions in this section
Availability
In release 6.4.0
Miscellaneous functions
Sections: Print
Printing to a file
Functions: ajTextoutprintBook ajTextoutprintHtml ajTextoutprintText ajTextoutprintWiki
Reports the text format internals as Docbook text
Synopsis
Prototype
void ajTextoutprintBook (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the text format internals as Docbook text
See Also
See other functions in this section
Availability
In release 6.4.0
Reports the internal data structures
Synopsis
Prototype
void ajTextoutprintHtml (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the internal data structures
See Also
See other functions in this section
Availability
In release 6.4.0
Reports the internal data structures
Synopsis
Prototype
void ajTextoutprintText (
AjPFile outf,
AjBool full
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| AjBool | full | Input | Full report (usually ajFalse) |
| void | | RETURN | |
Input
| full: | (Input) | Full report (usually ajFalse) |
Input & Output
Returns
Description
Reports the internal data structures
See Also
See other functions in this section
Availability
In release 6.4.0
Reports the text output format internals as wikitext
Synopsis
Prototype
void ajTextoutprintWiki (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the text output format internals as wikitext
See Also
See other functions in this section
Availability
In release 6.4.0
Values for output formats
Functions: ajTextoutformatFind ajTextoutformatTest
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 ajTextoutformatFind (
const AjPStr format,
ajint* iformat
);
| Type | Name | Read/Write | Description |
|---|
| const AjPStr | format | Input | Format required. |
| ajint* | iformat | Output | Index |
| AjBool | | RETURN | ajTrue on success. |
Input
| format: | (Input) | Format required. |
Output
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
Tests whether a named text output format is known
Synopsis
Prototype
AjBool ajTextoutformatTest (
const AjPStr format
);
| Type | Name | Read/Write | Description |
|---|
| const AjPStr | format | Input | Format |
| AjBool | | RETURN | ajTrue if formats was accepted |
Input
Returns
| AjBool: | ajTrue if formats was accepted |
Description
Tests whether a named text output format is known
See Also
See other functions in this section
Availability
In release 6.4.0
Functions to initialise and clean up internals
Functions: ajTextoutExit
Cleans up text data output internal memory
Synopsis
Prototype
void ajTextoutExit (
void
);
| Type | Name | Read/Write | Description |
|---|
| void | | RETURN | |
Returns
Description
Cleans up text data output internal memory
See Also
See other functions in this section
Availability
In release 6.4.0