ajassem.c

Datatypes: AjPAssem none


Datatype: AjPAssem

Assembly data

Sections: constructors Assem data destructors Casts assembly data modifiers


Section: constructors

Constructors

Functions: ajAssemNew


Function ajAssemNew

Assem data constructor

Synopsis

Prototype
AjPAssem ajAssemNew (
      void
);

TypeNameRead/WriteDescription
AjPAssem RETURNNew object

Returns
AjPAssem:New object

Description

Assem data constructor

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Assem data destructors

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

Functions: ajAssemDel


Function ajAssemDel

Assem data destructor

Synopsis

Prototype
void ajAssemDel (
      AjPAssem* Passem
);

TypeNameRead/WriteDescription
AjPAssem*PassemDeleteAssem data object to delete
void RETURN

Output
Passem:(Delete)Assem data object to delete
Returns
void:No return value

Description

Assem data destructor

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Casts

Return values from an assembly data object

Functions: ajAssemGetQryC ajAssemGetQryS


Function ajAssemGetQryC

Returns the query string of an assembly 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* ajAssemGetQryC (
      const AjPAssem assem
);

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

Input
assem:(Input)Assem data object.
Returns
const char*:Query as a character string.

Description

Returns the query string of an assembly 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

Function ajAssemGetQryS

Returns the query string of an assembly 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 ajAssemGetQryS (
      const AjPAssem assem
);

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

Input
assem:(Input)Assem data object.
Returns
const AjPStr:Query as a string.

Description

Returns the query string of an assembly 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

Section: assembly data modifiers

Assem data modifiers

Functions: ajAssemClear


Function ajAssemClear

Resets all data for an assembly data object so that it can be reused.

Synopsis

Prototype
void ajAssemClear (
      AjPAssem assem
);

TypeNameRead/WriteDescription
AjPAssemassemModifyassem data
void RETURN

Input & Output
assem:(Modify)assem data
Returns
void:No return value

Description

Resets all data for an assembly data object so that it can be reused.

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: none

Miscellaneous functions

Sections: exit


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: ajAssemExit


Function ajAssemExit

Cleans up assembly processing internal memory

Synopsis

Prototype
void ajAssemExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up assembly processing internal memory

See Also

See other functions in this section

Availability

In release 6.4.0