ajtext.c
Datatypes: AjPText none
Text data
Sections: constructors Text data destructors Casts text data modifiers
Constructors
Functions: ajTextNew
Text data constructor
Synopsis
Prototype
AjPText ajTextNew (
void
);
| Type | Name | Read/Write | Description |
|---|
| AjPText | | RETURN | New object |
Returns
Description
Text data constructor
See Also
See other functions in this section
Availability
In release 6.4.0
Destruction destroys all internal data structures and frees the
memory allocated for the text data object.
Functions: ajTextDel
Text data destructor
Synopsis
Prototype
void ajTextDel (
AjPText* Ptext
);
| Type | Name | Read/Write | Description |
|---|
| AjPText* | Ptext | Delete | Text data object to delete |
| void | | RETURN | |
Output
| Ptext: | (Delete) | Text data object to delete |
Returns
Description
Text data destructor
See Also
See other functions in this section
Availability
In release 6.4.0
Return values from a text data object
Functions: ajTextGetQryC ajTextGetQryS
Returns the query string of a text data object.
Because this is a pointer to the real internal string
the caller must take care not to change the character string in any way.
If the string is to be changed (case for example) then it must first
be copied.
Synopsis
Prototype
const char* ajTextGetQryC (
const AjPText text
);
| Type | Name | Read/Write | Description |
|---|
| const AjPText | text | Input | Text data object. |
| const char* | | RETURN | Query as a character string. |
Input
| text: | (Input) | Text data object. |
Returns
| const char*: | Query as a character string. |
Description
Returns the query string of a text data object.
Because this is a pointer to the real internal string
the caller must take care not to change the character string in any way.
If the string is to be changed (case for example) then it must first
be copied.
See Also
See other functions in this section
Availability
In release 6.4.0
Returns the query string of a text data object.
Because this is a pointer to the real internal string
the caller must take care not to change the character string in any way.
If the string is to be changed (case for example) then it must first
be copied.
Synopsis
Prototype
const AjPStr ajTextGetQryS (
const AjPText text
);
| Type | Name | Read/Write | Description |
|---|
| const AjPText | text | Input | Text data object. |
| const AjPStr | | RETURN | Query as a string. |
Input
| text: | (Input) | Text data object. |
Returns
| const AjPStr: | Query as a string. |
Description
Returns the query string of a text data object.
Because this is a pointer to the real internal string
the caller must take care not to change the character string in any way.
If the string is to be changed (case for example) then it must first
be copied.
See Also
See other functions in this section
Availability
In release 6.4.0
Text data modifiers
Functions: ajTextClear
Resets all data for a text data object so that it can be reused.
Synopsis
Prototype
void ajTextClear (
AjPText text
);
| Type | Name | Read/Write | Description |
|---|
| AjPText | text | Modify | text data |
| void | | RETURN | |
Input & Output
Returns
Description
Resets all data for a text data object so that it can be reused.
See Also
See other functions in this section
Availability
In release 6.4.0
Miscellaneous functions
Sections: exit
Functions called on exit from the program by ajExit to do
any necessary cleanup and to report internal statistics to the debug file
Functions: ajTextExit
Cleans up text processing internal memory
Synopsis
Prototype
void ajTextExit (
void
);
| Type | Name | Read/Write | Description |
|---|
| void | | RETURN | |
Returns
Description
Cleans up text processing internal memory
See Also
See other functions in this section
Availability
In release 6.4.0