ajurlwrite.c
Datatypes: AjPOutfile none
Url data output
Sections: url data outputs
These functions write the url data provided by the first argument
Functions: ajUrloutWrite
Write url data in a named format
Synopsis
Prototype
AjBool ajUrloutWrite (
AjPOutfile outf,
const AjPUrl url
);
| Type | Name | Read/Write | Description |
|---|
| AjPOutfile | outf | Modify | Output file |
| const AjPUrl | url | Input | Url data object |
| AjBool | | RETURN | True on success |
Input
| url: | (Input) | Url data object |
Input & Output
Returns
Description
Write url data 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: ajUrloutprintBook ajUrloutprintHtml ajUrloutprintText ajUrloutprintWiki
Reports the url format internals as Docbook text
Synopsis
Prototype
void ajUrloutprintBook (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the url 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 ajUrloutprintHtml (
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 ajUrloutprintText (
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 url output format internals as wikitext
Synopsis
Prototype
void ajUrloutprintWiki (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the url output format internals as wikitext
See Also
See other functions in this section
Availability
In release 6.4.0
Values for output formats
Functions: ajUrloutformatFind ajUrloutformatTest
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 ajUrloutformatFind (
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 URL output format is known
Synopsis
Prototype
AjBool ajUrloutformatTest (
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 URL 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: ajUrloutExit
Cleans up url output internal memory
Synopsis
Prototype
void ajUrloutExit (
void
);
| Type | Name | Read/Write | Description |
|---|
| void | | RETURN | |
Returns
Description
Cleans up url output internal memory
See Also
See other functions in this section
Availability
In release 6.4.0