ajvar.c

Datatypes: AjPVar none

Datatype: AjPVar

Variation data

Sections: constructors Variation data destructors Casts variation data modifiers

Section: constructors

Constructors

Functions: ajVarNew

Function ajVarNew

Var data constructor

Synopsis

Prototype
AjPVar ajVarNew (
      void
);

TypeNameRead/WriteDescription
AjPVar RETURNNew object

Returns
AjPVar:New object

Description

Var data constructor

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Variation data destructors

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

Functions: ajVarDel

Function ajVarDel

Variation data destructor

Synopsis

Prototype
void ajVarDel (
      AjPVar* Pvar
);

TypeNameRead/WriteDescription
AjPVar*PvarDeleteVariation data object to delete
void RETURN

Output
Pvar:(Delete)Variation data object to delete
Returns
void:No return value

Description

Variation data destructor

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Casts

Return values from a variation data object

Functions: ajVarGetDb ajVarGetId ajVarGetQryC ajVarGetQryS

Function ajVarGetDb

Return the database name

Synopsis

Prototype
const AjPStr ajVarGetDb (
      const AjPVar var
);

TypeNameRead/WriteDescription
const AjPVarvarInputVariation
const AjPStr RETURNDatabase name

Input
var:(Input)Variation
Returns
const AjPStr:Database name

Description

Return the database name

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVarGetId

Return the identifier

Synopsis

Prototype
const AjPStr ajVarGetId (
      const AjPVar var
);

TypeNameRead/WriteDescription
const AjPVarvarInputVariation
const AjPStr RETURNReturned id

Input
var:(Input)Variation
Returns
const AjPStr:Returned id

Description

Return the identifier

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVarGetQryC

Returns the query string of a variation 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* ajVarGetQryC (
      const AjPVar var
);

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

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

Description

Returns the query string of a variation 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 ajVarGetQryS

Returns the query string of a variation 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 ajVarGetQryS (
      const AjPVar var
);

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

Input
var:(Input)Variation data object.
Returns
const AjPStr:Query as a string.

Description

Returns the query string of a variation 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: variation data modifiers

Variation data modifiers

Functions: ajVarClear

Function ajVarClear

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

Synopsis

Prototype
void ajVarClear (
      AjPVar var
);

TypeNameRead/WriteDescription
AjPVarvarModifyVariation data object
void RETURN

Input & Output
var:(Modify)Variation data object
Returns
void:No return value

Description

Resets all data for a variation 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: ajVarExit

Function ajVarExit

Cleans up variation processing internal memory

Synopsis

Prototype
void ajVarExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up variation processing internal memory

See Also

See other functions in this section

Availability

In release 6.4.0