ajtext.c

Datatypes:
AjPText Text data
none Miscellaneous functions


Datatype: AjPText

Function is for manipulating text data objects

Sections:
constructorsConstructors
Text data destructorsDestructors
CastsCasts
text data modifiersModifiers


AjPText: constructors

Constructors

Functions:
ajTextNewText data constructor


Function ajTextNew

Text data constructor

Prototype

AjPText ajTextNew (
      void
);

TypeNameRead/WriteDescription
AjPText RETURNNew object

From EMBOSS 6.4.0


AjPText: Text data destructors

Destruction destroys all internal data structures and frees the memory allocated for the text data object.

Functions:
ajTextDelText data destructor


Function ajTextDel

Text data destructor

Prototype

void ajTextDel (
      AjPText* Ptext
);

TypeNameRead/WriteDescription
AjPText*PtextDeleteText data object to delete
void RETURN

From EMBOSS 6.4.0


AjPText: Casts

Return values from a text data object

Functions:
ajTextGetQryCReturns 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.
ajTextGetQrySReturns 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.


Function ajTextGetQryC

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.

Prototype

const char* ajTextGetQryC (
      const AjPText text
);

TypeNameRead/WriteDescription
const AjPTexttextInputText data object.
const char* RETURNQuery as a character string.

From EMBOSS 6.4.0


Function 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.

Prototype

const AjPStr ajTextGetQryS (
      const AjPText text
);

TypeNameRead/WriteDescription
const AjPTexttextInputText data object.
const AjPStr RETURNQuery as a string.

From EMBOSS 6.4.0


AjPText: text data modifiers

Text data modifiers

Functions:
ajTextClearResets all data for a text data object so that it can be reused.


Function ajTextClear

Resets all data for a text data object so that it can be reused.

Prototype

void ajTextClear (
      AjPText text
);

TypeNameRead/WriteDescription
AjPTexttextModifytext data
void RETURN

From EMBOSS 6.4.0


Datatype: none

Functions to initialise and clean up internals

Sections:
exitMiscellaneous


Section: 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:
ajTextExitCleans up text processing internal memory


Function ajTextExit

Cleans up text processing internal memory

Prototype

void ajTextExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0