ajsql.c

Datatypes:

none	Internals
AjPSqlconnection	SQL Connection
AjESqlconnectionClient	SQL Connection Client
AjPSqlstatement	AJAX SQL Statement
AjISqlrow	AJAX SQL Row Iterator
AjPSqlrow	AJAX SQL Row
AjPVoid	Void pointer

Datatype: none

Sections:

initialization	Internals
exiting	Internals

Section: initialization

Functions:

ajSqlInit

Initialises implementation-specific SQL client libraries.

Function ajSqlInit

Prototype

AjBool ajSqlInit (
      void
);

Type	Name	Read/Write	Description
AjBool		RETURN	ajTrue if the initialisation was successful.

From EMBOSS 6.2.0

Section: exiting

Functions:

ajSqlExit

Finalises implementation-specific SQL client libraries.

Function ajSqlExit

Prototype

void ajSqlExit (
      void
);

Type	Name	Read/Write	Description
void		RETURN

From EMBOSS 6.2.0

Datatype: AjPSqlconnection

Sections:

constructors	Constructors
destructors	Destructors
Cast	Casts
debugging	Miscellaneous

AjPSqlconnection: constructors

Functions:

ajSqlconnectionNewData	Default AJAX SQL Connection constructor, which also allocates a client library-specific connection object.
ajSqlconnectionNewRef	Ensembl Object referencing function, which returns a pointer to the Ensembl Object passed in and increases its reference count.

Function ajSqlconnectionNewData

Prototype

AjPSqlconnection ajSqlconnectionNewData (
      AjESqlconnectionClient client,
      const AjPStr user,
      const AjPStr password,
      const AjPStr host,
      const AjPStr port,
      const AjPStr socketfile,
      const AjPStr database
);

Type	Name	Read/Write	Description
AjESqlconnectionClient	client	Modify	SQL client
const AjPStr	user	Input	SQL account user name
const AjPStr	password	Input	SQL account password
const AjPStr	host	Input	SQL server hostname or IP address
const AjPStr	port	Input	SQL server port number
const AjPStr	socketfile	Input	SQL server UNIX socket file MySQL: Absolute path to the socket file. PostgreSQL: Absolute path to the socket directory only. Socket file names are then generated from this directory information and the port number above. See "%s/.s.PGSQL.%d" in macro UNIXSOCK_PATH in source file pgsql/src/include/libpq/pqcomm.h
const AjPStr	database	Input	SQL database name
AjPSqlconnection		RETURN	AJAX SQL Connection or NULL

From EMBOSS 6.2.0

Function ajSqlconnectionNewRef

Prototype

AjPSqlconnection ajSqlconnectionNewRef (
      AjPSqlconnection sqlc
);

Type	Name	Read/Write	Description
AjPSqlconnection	sqlc	Modify	AJAX SQL Connection
AjPSqlconnection		RETURN	AJAX SQL Connection or NULL

From EMBOSS 6.2.0

AjPSqlconnection: destructors

Functions:

ajSqlconnectionDel

Default AJAX SQL Connection destructor, which disconnects from the SQL server first, frees the client library-specific connection object and finally the AJAX SQL Connection object.

Function ajSqlconnectionDel

Prototype

void ajSqlconnectionDel (
      AjPSqlconnection* Psqlc
);

Type	Name	Read/Write	Description
AjPSqlconnection*	Psqlc	Delete	AJAX SQL Connection address
void		RETURN

From EMBOSS 6.2.0

AjPSqlconnection: Cast

Functions:

ajSqlconnectionEscapeC	Escape special characters in an AJAX String for use in an SQL statement, taking into account the current character set of the AJAX SQL Connection and return a C-type character string.
ajSqlconnectionEscapeS	Escape special characters in an AJAX String for use in an SQL statement, taking into account the current character set of the AJAX SQL Connection and return an AJAX String.
ajSqlconnectionGetClient	Get the client element of an AJAX SQL Connection.
ajSqlconnectionGetUse	Get the use counter element of an AJAX SQL Connection.

Function ajSqlconnectionEscapeC

Prototype

AjBool ajSqlconnectionEscapeC (
      const AjPSqlconnection sqlc,
      char** Ptxt,
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPSqlconnection	sqlc	Input	AJAX SQL Connection
char**	Ptxt	Output	Address of the (new) SQL-escaped C-type string
const AjPStr	str	Input	AJAX String to be escaped
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlconnectionEscapeS

Prototype

AjBool ajSqlconnectionEscapeS (
      const AjPSqlconnection sqlc,
      AjPStr* Pstr,
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPSqlconnection	sqlc	Input	AJAX SQL Connection
AjPStr*	Pstr	Output	Address of the (new) SQL-escaped AJAX String
const AjPStr	str	Input	AJAX String to be escaped
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlconnectionGetClient

Prototype

AjESqlconnectionClient ajSqlconnectionGetClient (
      const AjPSqlconnection sqlc
);

Type	Name	Read/Write	Description
const AjPSqlconnection	sqlc	Input	AJAX SQL Connection
AjESqlconnectionClient		RETURN	AJAX SQL Connection client or ajESqlconnectionClientNULL

From EMBOSS 6.2.0

Function ajSqlconnectionGetUse

Prototype

ajuint ajSqlconnectionGetUse (
      const AjPSqlconnection sqlc
);

Type	Name	Read/Write	Description
const AjPSqlconnection	sqlc	Input	AJAX SQL Connection
ajuint		RETURN	Use counter

From EMBOSS 6.3.0

AjPSqlconnection: debugging

Functions:

ajSqlconnectionTrace

Trace an AJAX SQL Connection.

Function ajSqlconnectionTrace

Prototype

AjBool ajSqlconnectionTrace (
      const AjPSqlconnection sqlc,
      ajuint level
);

Type	Name	Read/Write	Description
const AjPSqlconnection	sqlc	Input	AJAX SQL Connection
ajuint	level	Input	Indentation level
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Datatype: AjESqlconnectionClient

Sections:

Misc	Miscellaneous
Cast	Casts

AjESqlconnectionClient: Misc

Functions:

ajSqlconnectionClientFromStr

Convert an AJAX String into an AJAX SQL Connection client element.

Function ajSqlconnectionClientFromStr

Prototype

AjESqlconnectionClient ajSqlconnectionClientFromStr (
      const AjPStr client
);

Type	Name	Read/Write	Description
const AjPStr	client	Input	Client string
AjESqlconnectionClient		RETURN	AJAX SQL Connection client or ajESqlconnectionClientNULL

From EMBOSS 6.3.0

AjESqlconnectionClient: Cast

Functions:

ajSqlconnectionClientToChar

Convert an AJAX SQL Connection client element into a C-type (char*) string.

Function ajSqlconnectionClientToChar

Prototype

const char* ajSqlconnectionClientToChar (
      AjESqlconnectionClient client
);

Type	Name	Read/Write	Description
AjESqlconnectionClient	client	Modify	SQL Connection client
const char*		RETURN	SQL Connection client C-type (char*) string

From EMBOSS 6.3.0

Datatype: AjPSqlstatement

Sections:

constructors	Constructors
destructors	Destructors
cast	Casts

AjPSqlstatement: constructors

Functions:

ajSqlstatementNewRef	Ensembl Object referencing function, which returns a pointer to the Ensembl Object passed in and increases its reference count.
ajSqlstatementNewRun	Default AJAX SQL Statement constructor. Upon construction the SQL Statement is run against the SQL server specified in the AJAX SQL Connection. Eventual results of the SQL Statement are then stored inside this object.

Function ajSqlstatementNewRef

Prototype

AjPSqlstatement ajSqlstatementNewRef (
      AjPSqlstatement sqls
);

Type	Name	Read/Write	Description
AjPSqlstatement	sqls	Modify	AJAX SQL Statement
AjPSqlstatement		RETURN	AJAX SQL Statement or NULL

From EMBOSS 6.2.0

Function ajSqlstatementNewRun

Prototype

AjPSqlstatement ajSqlstatementNewRun (
      AjPSqlconnection sqlc,
      const AjPStr statement
);

Type	Name	Read/Write	Description
AjPSqlconnection	sqlc	Modify	AJAX SQL Connection
const AjPStr	statement	Input	SQL statement
AjPSqlstatement		RETURN	AJAX SQL Statement or NULL

From EMBOSS 6.2.0

AjPSqlstatement: destructors

Functions:

ajSqlstatementDel

Default AJAX SQL Statement destructor, which also destroys the SQL client library-specific result object.

Function ajSqlstatementDel

Prototype

void ajSqlstatementDel (
      AjPSqlstatement* Psqls
);

Type	Name	Read/Write	Description
AjPSqlstatement*	Psqls	Delete	AJAX SQL Statement address
void		RETURN

From EMBOSS 6.2.0

AjPSqlstatement: cast

Functions:

ajSqlstatementGetAffectedrows	Get the number of rows affected by a non-SELECT SQL statement.
ajSqlstatementGetColumns	Get the number of columns returned by a SELECT-like SQL statement.
ajSqlstatementGetIdentifier	Get the identifier of a row inserted by the last INSERT-like SQL statement.
ajSqlstatementGetSelectedrows	Get the number of rows selected by a SELECT-like SQL statement.

Function ajSqlstatementGetAffectedrows

Prototype

ajulong ajSqlstatementGetAffectedrows (
      const AjPSqlstatement sqls
);

Type	Name	Read/Write	Description
const AjPSqlstatement	sqls	Input	AJAX SQL Statement
ajulong		RETURN	Number of affected rows

From EMBOSS 6.2.0

Function ajSqlstatementGetColumns

Prototype

ajuint ajSqlstatementGetColumns (
      const AjPSqlstatement sqls
);

Type	Name	Read/Write	Description
const AjPSqlstatement	sqls	Input	AJAX SQL Statement
ajuint		RETURN	Number of selected columns

From EMBOSS 6.2.0

Function ajSqlstatementGetIdentifier

Prototype

ajuint ajSqlstatementGetIdentifier (
      const AjPSqlstatement sqls
);

Type	Name	Read/Write	Description
const AjPSqlstatement	sqls	Input	AJAX SQL Statement
ajuint		RETURN	Identifier of last inserted row

From EMBOSS 6.2.0

Function ajSqlstatementGetSelectedrows

Prototype

ajulong ajSqlstatementGetSelectedrows (
      const AjPSqlstatement sqls
);

Type	Name	Read/Write	Description
const AjPSqlstatement	sqls	Input	AJAX SQL Statement
ajulong		RETURN	Number of selected rows

From EMBOSS 6.2.0

Datatype: AjISqlrow

Sections:

constructors	Constructors
destructors	Destructors
tests	General use
stepping	Modifiers
modifiers	Modifiers

AjISqlrow: constructors

Functions:

ajSqlrowiterNew

Default AJAX SQL Row Iterator constructor.

Function ajSqlrowiterNew

Prototype

AjISqlrow ajSqlrowiterNew (
      AjPSqlstatement sqls
);

Type	Name	Read/Write	Description
AjPSqlstatement	sqls	Modify	AJAX SQL Statement
AjISqlrow		RETURN	AJAX SQL Row Iterator or NULL if the AJAX SQL Statement did not return rows and columns

From EMBOSS 6.2.0

AjISqlrow: destructors

Functions:

ajSqlrowiterDel

Default AJAX SQL Row Iterator destructor.

Function ajSqlrowiterDel

Prototype

void ajSqlrowiterDel (
      AjISqlrow* Psqli
);

Type	Name	Read/Write	Description
AjISqlrow*	Psqli	Delete	AJAX SQL Row Iterator address
void		RETURN

From EMBOSS 6.2.0

AjISqlrow: tests

Functions:

ajSqlrowiterDone

Tests whether an AJAX SQL Row Iterator has completed yet.

Function ajSqlrowiterDone

Prototype

AjBool ajSqlrowiterDone (
      const AjISqlrow sqli
);

Type	Name	Read/Write	Description
const AjISqlrow	sqli	Input	AJAX SQL Row Iterator
AjBool		RETURN	ajTrue if the iterator is exhausted

From EMBOSS 6.2.0

AjISqlrow: stepping

Functions:

ajSqlrowiterGet

Returns the next AJAX SQL Row using the iterator, or steps off the end.

Function ajSqlrowiterGet

Prototype

AjPSqlrow ajSqlrowiterGet (
      AjISqlrow sqli
);

Type	Name	Read/Write	Description
AjISqlrow	sqli	Modify	AJAX SQL Row Iterator
AjPSqlrow		RETURN	AJAX SQL Row or NULL

From EMBOSS 6.2.0

AjISqlrow: modifiers

Functions:

ajSqlrowiterRewind

Rewind an AJAX SQL Row Iterator to the start position.

Function ajSqlrowiterRewind

Prototype

AjBool ajSqlrowiterRewind (
      AjISqlrow sqli
);

Type	Name	Read/Write	Description
AjISqlrow	sqli	Modify	AJAX SQL Row Iterator
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Datatype: AjPSqlrow

Sections:

constructors	Constructors
destructors	Destructors
element retrieval	General use

AjPSqlrow: constructors

Functions:

ajSqlrowNew

Default AJAX SQL Row constructor.

Function ajSqlrowNew

Prototype

AjPSqlrow ajSqlrowNew (
      ajuint columns
);

Type	Name	Read/Write	Description
ajuint	columns	Input	Number of columns per AJAX SQL Row
AjPSqlrow		RETURN	AJAX SQL Row

From EMBOSS 6.2.0

AjPSqlrow: destructors

Functions:

ajSqlrowDel

Default AJAX SQL Row destructor.

Function ajSqlrowDel

Prototype

void ajSqlrowDel (
      AjPSqlrow* Psqlr
);

Type	Name	Read/Write	Description
AjPSqlrow*	Psqlr	Delete	AJAX SQL Row address
void		RETURN

From EMBOSS 6.2.0

AjPSqlrow: element retrieval

Functions:

ajSqlrowGetColumns	Get the number of columns in an AJAX SQL Row.
ajSqlrowGetCurrent	Get the number of the current column in column iterations of an AJAX SQL Row.
ajSqlrowGetLengths	Get the AJAX Long Integer Array of column value lengths in an AJAX SQL Row.
ajSqlrowGetValues	Get the AJAX Void Pointer Array of column values in an AJAX SQL Row.

Function ajSqlrowGetColumns

Prototype

ajuint ajSqlrowGetColumns (
      const AjPSqlrow sqlr
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint		RETURN	Number of columns in an AJAX SQL Row

From EMBOSS 6.2.0

Function ajSqlrowGetCurrent

Prototype

ajuint ajSqlrowGetCurrent (
      const AjPSqlrow sqlr
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint		RETURN	Number of current column of an AJAX SQL Row

From EMBOSS 6.2.0

Function ajSqlrowGetLengths

Prototype

AjPLong ajSqlrowGetLengths (
      const AjPSqlrow sqlr
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
AjPLong		RETURN	AJAX Long Integer Array

From EMBOSS 6.2.0

Function ajSqlrowGetValues

Prototype

AjPVoid ajSqlrowGetValues (
      const AjPSqlrow sqlr
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
AjPVoid		RETURN	AJAX Void Pointer Array

From EMBOSS 6.2.0

AjPSqlrow: column modifiers

Functions:

ajSqlcolumnRewind

Rewind an AJAX SQL Column Iterator to the start position.

Function ajSqlcolumnRewind

Prototype

AjBool ajSqlcolumnRewind (
      AjPSqlrow sqlr
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

AjPSqlrow: column retrieval

Functions:

ajSqlcolumnGetValue

Get the value of the next column of an AJAX SQL Row. Calling this function also advances the column iterator.

Function ajSqlcolumnGetValue

Prototype

AjBool ajSqlcolumnGetValue (
      AjPSqlrow sqlr,
      void** Pvalue,
      ajulong* Plength
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
void**	Pvalue	Modify	Value address
ajulong*	Plength	Modify	Value length address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

AjPSqlrow: column to datatype conversion functions

Functions:

ajSqlcolumnToBool	Converts the value in the next column of an AJAX SQL Row into an AJAX Boolean value.
ajSqlcolumnToDouble	Converts the value in the next column of an AJAX SQL Row into a C-type double value.
ajSqlcolumnToFloat	Converts the value in the next column of an AJAX SQL Row into a C-type float value.
ajSqlcolumnToInt	Converts the value in the next column of an AJAX SQL Row into an AJAX Integer value.
ajSqlcolumnToLong	Converts the value in the next column of an AJAX SQL Row into an AJAX Long Integer value.
ajSqlcolumnToStr	Converts the value of the next column of an AJAX SQL Row into an AJAX String value.
ajSqlcolumnToTime	Converts the value in the next column of an AJAX SQL Row into an AJAX Time value.
ajSqlcolumnToUint	Converts the value in the next column of an AJAX SQL Row into an AJAX Unsigned Integer value.
ajSqlcolumnToUlong	Converts the value in the next column of an AJAX SQL Row into an AJAX Unsigned Long Integer value.

Function ajSqlcolumnToBool

Prototype

AjBool ajSqlcolumnToBool (
      AjPSqlrow sqlr,
      AjBool* Pvalue
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
AjBool*	Pvalue	Output	AJAX Boolean address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnToDouble

Prototype

AjBool ajSqlcolumnToDouble (
      AjPSqlrow sqlr,
      double* Pvalue
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
double*	Pvalue	Output	C-type double address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnToFloat

Prototype

AjBool ajSqlcolumnToFloat (
      AjPSqlrow sqlr,
      float* Pvalue
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
float*	Pvalue	Output	C-type float address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnToInt

Prototype

AjBool ajSqlcolumnToInt (
      AjPSqlrow sqlr,
      ajint* Pvalue
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
ajint*	Pvalue	Output	AJAX Integer address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnToLong

Prototype

AjBool ajSqlcolumnToLong (
      AjPSqlrow sqlr,
      ajlong* Pvalue
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
ajlong*	Pvalue	Output	AJAX Long Integer address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnToStr

Prototype

AjBool ajSqlcolumnToStr (
      AjPSqlrow sqlr,
      AjPStr* Pvalue
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
AjPStr*	Pvalue	Output	AJAX String address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnToTime

Prototype

AjBool ajSqlcolumnToTime (
      AjPSqlrow sqlr,
      AjPTime* Pvalue
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
AjPTime*	Pvalue	Output	AJAX Time address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnToUint

Prototype

AjBool ajSqlcolumnToUint (
      AjPSqlrow sqlr,
      ajuint* Pvalue
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
ajuint*	Pvalue	Output	AJAX Unsigned Integer address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnToUlong

Prototype

AjBool ajSqlcolumnToUlong (
      AjPSqlrow sqlr,
      ajulong* Pvalue
);

Type	Name	Read/Write	Description
AjPSqlrow	sqlr	Modify	AJAX SQL Row
ajulong*	Pvalue	Output	AJAX Unsigned Long Integer address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.3.0

AjPSqlrow: column retrieval

Functions:

ajSqlcolumnNumberGetValue

Get the value of a particular column of an AJAX SQL Row.

Function ajSqlcolumnNumberGetValue

Prototype

AjBool ajSqlcolumnNumberGetValue (
      const AjPSqlrow sqlr,
      ajuint column,
      void** Pvalue,
      ajulong* Plength
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
void**	Pvalue	Modify	Value address
ajulong*	Plength	Modify	Value length address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

AjPSqlrow: column to datatype conversion functions

Functions:

ajSqlcolumnNumberToBool	Converts the value in a particular column of an AJAX SQL Row into an AJAX Boolean value.
ajSqlcolumnNumberToDouble	Converts the value in a particular column of an AJAX SQL Row into a C-type double value.
ajSqlcolumnNumberToFloat	Converts the value in a particular column of an AJAX SQL Row into a C-type float value.
ajSqlcolumnNumberToInt	Converts the value in a particular column of an AJAX SQL Row into an AJAX Integer value.
ajSqlcolumnNumberToLong	Converts the value in a particular column of an AJAX SQL Row into an AJAX Long Integer value.
ajSqlcolumnNumberToStr	Converts the value in a particular column of an AJAX SQL Row into an AJAX String value.
ajSqlcolumnNumberToTime	Converts the value in a particular column of an AJAX SQL Row into an AJAX Time value.
ajSqlcolumnNumberToUint	Converts the value in a particular column of an AJAX SQL Row into an AJAX Unsigned Integer value.
ajSqlcolumnNumberToUlong	Converts the value in a particular column of an AJAX SQL Row into an AJAX Unsigned Long Integer value.

Function ajSqlcolumnNumberToBool

Prototype

AjBool ajSqlcolumnNumberToBool (
      const AjPSqlrow sqlr,
      ajuint column,
      AjBool* Pvalue
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
AjBool*	Pvalue	Output	AJAX Boolean address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnNumberToDouble

Prototype

AjBool ajSqlcolumnNumberToDouble (
      const AjPSqlrow sqlr,
      ajuint column,
      double* Pvalue
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
double*	Pvalue	Output	C-type double address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnNumberToFloat

Prototype

AjBool ajSqlcolumnNumberToFloat (
      const AjPSqlrow sqlr,
      ajuint column,
      float* Pvalue
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
float*	Pvalue	Output	C-type float address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnNumberToInt

Prototype

AjBool ajSqlcolumnNumberToInt (
      const AjPSqlrow sqlr,
      ajuint column,
      ajint* Pvalue
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
ajint*	Pvalue	Output	AJAX Integer address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnNumberToLong

Prototype

AjBool ajSqlcolumnNumberToLong (
      const AjPSqlrow sqlr,
      ajuint column,
      ajlong* Pvalue
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
ajlong*	Pvalue	Output	AJAX Long Integer address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnNumberToStr

Prototype

AjBool ajSqlcolumnNumberToStr (
      const AjPSqlrow sqlr,
      ajuint column,
      AjPStr* Pvalue
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
AjPStr*	Pvalue	Output	AJAX String address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnNumberToTime

Prototype

AjBool ajSqlcolumnNumberToTime (
      const AjPSqlrow sqlr,
      ajuint column,
      AjPTime* Pvalue
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
AjPTime*	Pvalue	Output	AJAX Time address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnNumberToUint

Prototype

AjBool ajSqlcolumnNumberToUint (
      const AjPSqlrow sqlr,
      ajuint column,
      ajuint* Pvalue
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
ajuint*	Pvalue	Output	AJAX Unsigned Integer address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.2.0

Function ajSqlcolumnNumberToUlong

Prototype

AjBool ajSqlcolumnNumberToUlong (
      const AjPSqlrow sqlr,
      ajuint column,
      ajulong* Pvalue
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
ajulong*	Pvalue	Output	AJAX Unsigned Long Integer address
AjBool		RETURN	ajTrue upon success, ajFalse otherwise

From EMBOSS 6.3.0

AjPSqlrow: tests

Functions:

ajSqlcolumnNumberIsDefined

Test if the value in a particular column of an AJAX SQL Row is defined.

Function ajSqlcolumnNumberIsDefined

Prototype

AjBool ajSqlcolumnNumberIsDefined (
      const AjPSqlrow sqlr,
      ajuint column
);

Type	Name	Read/Write	Description
const AjPSqlrow	sqlr	Input	AJAX SQL Row
ajuint	column	Input	Column number
AjBool		RETURN	ajTrue if the value is defined, ajFalse if the value is undefined (\N)

From EMBOSS 6.2.0

Datatype: AjPVoid

Sections:

constructors	Constructors
destructors	Destructors
Cast	Casts
modifiers	Modifiers

AjPVoid: constructors

Functions:

ajVoidNew	Default constructor for empty AJAX Void Pointer Arrays.
ajVoidNewRes	Constructor given an initial reserved size.

Function ajVoidNew

Prototype

AjPVoid ajVoidNew (
      void
);

Type	Name	Read/Write	Description
AjPVoid		RETURN	Pointer to an empty Pointer Array structure

From EMBOSS 6.2.0

Function ajVoidNewRes

Prototype

AjPVoid ajVoidNewRes (
      ajuint size
);

Type	Name	Read/Write	Description
ajuint	size	Input	Reserved size
AjPVoid		RETURN	Pointer to an empty Pointer Array struct of specified size

From EMBOSS 6.2.0

AjPVoid: destructors

Functions:

ajVoidDel

Default destructor for AJAX Pointer arrays.

Function ajVoidDel

Prototype

void ajVoidDel (
      AjPVoid* thys
);

Type	Name	Read/Write	Description
AjPVoid*	thys	Delete	Pointer to the Pointer Array to be deleted. The pointer is always deleted.
void		RETURN

From EMBOSS 6.2.0

AjPVoid: Cast

Functions:

ajVoidGet	Retrieve an element from an AJAX Pointer Array.
ajVoidLen	Get length of dynamic 1d AJAX Pointer Array.

Function ajVoidGet

Prototype

void* ajVoidGet (
      const AjPVoid thys,
      ajuint elem
);

Type	Name	Read/Write	Description
const AjPVoid	thys	Input	Pointer to the Pointer array
ajuint	elem	Input	array element
void*		RETURN	contents of array element

From EMBOSS 6.2.0

Function ajVoidLen

Prototype

ajuint ajVoidLen (
      const AjPVoid thys
);

Type	Name	Read/Write	Description
const AjPVoid	thys	Input	AJAX Pointer Array
ajuint		RETURN	length

From EMBOSS 6.4.0

AjPVoid: modifiers

Functions:

ajVoidPut

Load a void pointer array element.

Function ajVoidPut

Prototype

AjBool ajVoidPut (
      AjPVoid* thys,
      ajuint elem,
      void* v
);

Type	Name	Read/Write	Description
AjPVoid*	thys	Output	Pointer to the void pointer array
ajuint	elem	Input	array element
void*	v	Input	value to load
AjBool		RETURN	true if the array was extended

From EMBOSS 6.2.0