ajnam.c

Function ajNamPrintSvrAttr

Prints a report of the server attributes available (for entrails)

Prototype

void ajNamPrintSvrAttr (
      AjPFile outf,
      AjBool full
);

Type Name Read/Write Description

AjPFile outf Modify Output file

AjBool full Input Full output if AjTrue

void RETURN

Type	Name	Read/Write	Description
`AjPFile`	`outf`	Modify	Output file
`AjBool`	`full`	Input	Full output if AjTrue
`void`		RETURN

From EMBOSS 6.4.0

Function ajNamPrintDbAttr

Prints a report of the database attributes available (for entrails)

Prototype

void ajNamPrintDbAttr (
      AjPFile outf,
      AjBool full
);

Type Name Read/Write Description

AjPFile outf Modify Output file

AjBool full Input Full output if AjTrue

void RETURN

Type	Name	Read/Write	Description
`AjPFile`	`outf`	Modify	Output file
`AjBool`	`full`	Input	Full output if AjTrue
`void`		RETURN

From EMBOSS 2.5.0

Function ajNamPrintRsAttr

Prints a report of the resource attributes available (for entrails)

Prototype

void ajNamPrintRsAttr (
      AjPFile outf,
      AjBool full
);

Type Name Read/Write Description

AjPFile outf Modify Output file

AjBool full Input Full output if AjTrue

void RETURN

Type	Name	Read/Write	Description
`AjPFile`	`outf`	Modify	Output file
`AjBool`	`full`	Input	Full output if AjTrue
`void`		RETURN

From EMBOSS 2.7.0

Prototype

AjBool ajNamSvrGetAttrC (
      const AjPStr name,
      const char* attribute,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input server name

const char* attribute Input server attribute name

AjPStr* value Output attribute value

AjBool RETURN true if found

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	server name
`const char*`	`attribute`	Input	server attribute name
`AjPStr*`	`value`	Output	attribute value
`AjBool`		RETURN	true if found

From EMBOSS 6.4.0

Function ajNamSvrGetAttrS

Return the value for a server attribute

Prototype

AjBool ajNamSvrGetAttrS (
      const AjPStr name,
      const AjPStr attribute,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input server name

const AjPStr attribute Input server attribute name

AjPStr* value Output attribute value

AjBool RETURN true if found

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	server name
`const AjPStr`	`attribute`	Input	server attribute name
`AjPStr*`	`value`	Output	attribute value
`AjBool`		RETURN	true if found

From EMBOSS 6.4.0

Function ajNamSvrGetAttrlist

Return a list of names and values for all of a server defined attributes

Prototype

AjPList ajNamSvrGetAttrlist (
      const AjPStr name
);

Type Name Read/Write Description

const AjPStr name Input server name

AjPList RETURN Nam-value list

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	server name
`AjPList`		RETURN	Nam-value list

From EMBOSS 6.4.0

Function ajNamSvrGetdbAttrC

Return the value for a server database attribute

Prototype

AjBool ajNamSvrGetdbAttrC (
      const AjPStr name,
      const AjPStr dbname,
      const char* attribute,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input server name

const AjPStr dbname Input database name

const char* attribute Input database attribute name

AjPStr* value Output attribute value

AjBool RETURN true if found

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	server name
`const AjPStr`	`dbname`	Input	database name
`const char*`	`attribute`	Input	database attribute name
`AjPStr*`	`value`	Output	attribute value
`AjBool`		RETURN	true if found

From EMBOSS 6.4.0

Function ajNamSvrGetdbAttrS

Return the value for a database attribute

Prototype

AjBool ajNamSvrGetdbAttrS (
      const AjPStr name,
      const AjPStr dbname,
      const AjPStr attribute,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input server name

const AjPStr dbname Input database name

const AjPStr attribute Input database attribute name

AjPStr* value Output attribute value

AjBool RETURN true if found

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	server name
`const AjPStr`	`dbname`	Input	database name
`const AjPStr`	`attribute`	Input	database attribute name
`AjPStr*`	`value`	Output	attribute value
`AjBool`		RETURN	true if found

From EMBOSS 6.4.0

Function ajNamSvrDetails

Returns server access method information

Prototype

AjBool ajNamSvrDetails (
      const AjPStr name,
      AjPStr* type,
      AjPStr* scope,
      AjBool* id,
      AjBool* qry,
      AjBool* all,
      AjPStr* comment,
      AjPStr* svrversion,
      AjPStr* methods,
      AjPStr* defined,
      AjPStr* cachedirectory,
      AjPStr* cachefile,
      AjPStr* url
);

Type Name Read/Write Description

const AjPStr name Input Server name

AjPStr* type Output datatype - 'Protein', 'Nucleic' etc.

AjPStr* scope Output datatype scope Sequence Features etc.

AjBool* id Output ajTrue = can access single entries

AjBool* qry Output ajTrue = can access wild/query entries

AjBool* all Output ajTrue = can access all entries

AjPStr* comment Output comment about server

AjPStr* svrversion Output Server version

AjPStr* methods Output server access methods formatted

AjPStr* defined Output server definition file short name

AjPStr* cachedirectory Output cache directory name

AjPStr* cachefile Output cache file name

AjPStr* url Output server URL

AjBool RETURN ajTrue if server details were found

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	Server name
`AjPStr*`	`type`	Output	datatype - 'Protein', 'Nucleic' etc.
`AjPStr*`	`scope`	Output	datatype scope Sequence Features etc.
`AjBool*`	`id`	Output	ajTrue = can access single entries
`AjBool*`	`qry`	Output	ajTrue = can access wild/query entries
`AjBool*`	`all`	Output	ajTrue = can access all entries
`AjPStr*`	`comment`	Output	comment about server
`AjPStr*`	`svrversion`	Output	Server version
`AjPStr*`	`methods`	Output	server access methods formatted
`AjPStr*`	`defined`	Output	server definition file short name
`AjPStr*`	`cachedirectory`	Output	cache directory name
`AjPStr*`	`cachefile`	Output	cache file name
`AjPStr*`	`url`	Output	server URL
`AjBool`		RETURN	ajTrue if server details were found

From EMBOSS 6.4.0

Function ajNamDbGetAttrC

Return the value for a database attribute

Prototype

AjBool ajNamDbGetAttrC (
      const AjPStr name,
      const char* attribute,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input database name

const char* attribute Input database attribute name

AjPStr* value Output attribute value

AjBool RETURN true if found

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	database name
`const char*`	`attribute`	Input	database attribute name
`AjPStr*`	`value`	Output	attribute value
`AjBool`		RETURN	true if found

From EMBOSS 6.4.0

Function ajNamDbGetAttrS

Return the value for a database attribute

Prototype

AjBool ajNamDbGetAttrS (
      const AjPStr name,
      const AjPStr attribute,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input database name

const AjPStr attribute Input database attribute name

AjPStr* value Output attribute value

AjBool RETURN true if found

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	database name
`const AjPStr`	`attribute`	Input	database attribute name
`AjPStr*`	`value`	Output	attribute value
`AjBool`		RETURN	true if found

From EMBOSS 6.4.0

Function ajNamDbGetAttrlist

Return a list of names and values for all of a database defined attributes

Prototype

AjPList ajNamDbGetAttrlist (
      const AjPStr name
);

Type Name Read/Write Description

const AjPStr name Input database name

AjPList RETURN Nam-value list

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	database name
`AjPList`		RETURN	Nam-value list

From EMBOSS 6.4.0

Function ajNamDbDetails

Returns database access method information

Prototype

AjBool ajNamDbDetails (
      const AjPStr name,
      AjPStr* type,
      AjBool* id,
      AjBool* qry,
      AjBool* all,
      AjPStr* comment,
      AjPStr* release,
      AjPStr* methods,
      AjPStr* defined
);

Type Name Read/Write Description

const AjPStr name Input Database name

AjPStr* type Output sequence type - 'P' or 'N'

AjBool* id Output ajTrue = can access single entries

AjBool* qry Output ajTrue = can access wild/query entries

AjBool* all Output ajTrue = can access all entries

AjPStr* comment Output comment about database

AjPStr* release Output database release date

AjPStr* methods Output database access methods formatted

AjPStr* defined Output database definition file short name

AjBool RETURN ajTrue if database details were found

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	Database name
`AjPStr*`	`type`	Output	sequence type - 'P' or 'N'
`AjBool*`	`id`	Output	ajTrue = can access single entries
`AjBool*`	`qry`	Output	ajTrue = can access wild/query entries
`AjBool*`	`all`	Output	ajTrue = can access all entries
`AjPStr*`	`comment`	Output	comment about database
`AjPStr*`	`release`	Output	database release date
`AjPStr*`	`methods`	Output	database access methods formatted
`AjPStr*`	`defined`	Output	database definition file short name
`AjBool`		RETURN	ajTrue if database details were found

From EMBOSS 1.0.0

Function ajNamDebugOrigin

Writes a simple list of where the internal tables came from..

Prototype

void ajNamDebugOrigin (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 1.13.0

Function ajNamDebugServers

Writes a simple debug report of all servers in the internal table.

Prototype

void ajNamDebugServers (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 6.4.0

Function ajNamDebugDatabases

Writes a simple debug report of all databases in the internal table.

Prototype

void ajNamDebugDatabases (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 1.13.0

Function ajNamDebugResources

Writes a simple debug report of all databases in the internal table.

Prototype

void ajNamDebugResources (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 2.7.0

Function ajNamDebugVariables

Writes a simple debug report of all environment variables in the internal table.

Prototype

void ajNamDebugVariables (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 2.7.0

Function ajNamDebugAliases

Writes a simple debug report of all aliases in the internal table.

Prototype

void ajNamDebugAliases (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 6.4.0

Function ajNamListListServers

Creates a AjPList list of all servers in the internal table.

Prototype

void ajNamListListServers (
      AjPList svrnames
);

Type Name Read/Write Description

AjPList svrnames Output Str List of names to be populated

void RETURN

Type	Name	Read/Write	Description
`AjPList`	`svrnames`	Output	Str List of names to be populated
`void`		RETURN

From EMBOSS 6.4.0

Function ajNamListListDatabases

Creates a AjPList list of all databases in the internal table.

Prototype

void ajNamListListDatabases (
      AjPList dbnames
);

Type Name Read/Write Description

AjPList dbnames Output Str List of names to be populated

void RETURN

Type	Name	Read/Write	Description
`AjPList`	`dbnames`	Output	Str List of names to be populated
`void`		RETURN

From EMBOSS 1.0.0

Function ajNamListListResources

Creates a AjPList list of all databases in the internal table.

Prototype

void ajNamListListResources (
      AjPList rsnames
);

Type Name Read/Write Description

AjPList rsnames Output Str List of names to be populated

void RETURN

Type	Name	Read/Write	Description
`AjPList`	`rsnames`	Output	Str List of names to be populated
`void`		RETURN

From EMBOSS 2.7.0

Function ajNamIsDbname

Returns true if the name is a valid database (or server) name.

Prototype

AjBool ajNamIsDbname (
      const AjPStr name
);

Type Name Read/Write Description

const AjPStr name Input character string to find in getenv list

AjBool RETURN True if name was defined.

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	character string to find in getenv list
`AjBool`		RETURN	True if name was defined.

From EMBOSS 3.0.0

Function ajNamGetenvC

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns value as NULL;

Prototype

AjBool ajNamGetenvC (
      const char* name,
      AjPStr* value
);

Type Name Read/Write Description

const char* name Input character string to find in getenv list

AjPStr* value Output String for the value.

AjBool RETURN True if name was defined.

Type	Name	Read/Write	Description
`const char*`	`name`	Input	character string to find in getenv list
`AjPStr*`	`value`	Output	String for the value.
`AjBool`		RETURN	True if name was defined.

From EMBOSS 2.9.0

Function ajNamGetenvS

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns NULL;

Prototype

AjBool ajNamGetenvS (
      const AjPStr name,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input character string to find in getenv list

AjPStr* value Output String for the value.

AjBool RETURN True if name was defined.

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	character string to find in getenv list
`AjPStr*`	`value`	Output	String for the value.
`AjBool`		RETURN	True if name was defined.

From EMBOSS 6.1.0

Function ajNamGetAliasC

Looks for name as an alias in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Prototype

AjBool ajNamGetAliasC (
      const char* name,
      AjPStr* value
);

Type Name Read/Write Description

const char* name Input character string find in hash table.

AjPStr* value Output Str for the value.

AjBool RETURN True if name was defined.

Type	Name	Read/Write	Description
`const char*`	`name`	Input	character string find in hash table.
`AjPStr*`	`value`	Output	Str for the value.
`AjBool`		RETURN	True if name was defined.

From EMBOSS 6.4.0

Function ajNamGetAliasS

Looks for name as an alias in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Prototype

AjBool ajNamGetAliasS (
      const AjPStr namestr,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr namestr Input character string find in hash table.

AjPStr* value Output Str for the value.

AjBool RETURN True if name was defined.

Type	Name	Read/Write	Description
`const AjPStr`	`namestr`	Input	character string find in hash table.
`AjPStr*`	`value`	Output	Str for the value.
`AjBool`		RETURN	True if name was defined.

From EMBOSS 6.4.0

Function ajNamGetValueC

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Prototype

AjBool ajNamGetValueC (
      const char* name,
      AjPStr* value
);

Type Name Read/Write Description

const char* name Input character string find in hash table.

AjPStr* value Output Str for the value.

AjBool RETURN True if name was defined.

Type	Name	Read/Write	Description
`const char*`	`name`	Input	character string find in hash table.
`AjPStr*`	`value`	Output	Str for the value.
`AjBool`		RETURN	True if name was defined.

From EMBOSS 1.0.0

Function ajNamGetValueS

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Prototype

AjBool ajNamGetValueS (
      const AjPStr name,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input character string find in hash table.

AjPStr* value Output String for the value.

AjBool RETURN True if name was defined.

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	character string find in hash table.
`AjPStr*`	`value`	Output	String for the value.
`AjBool`		RETURN	True if name was defined.

From EMBOSS 6.1.0

Function ajNamServer

Looks for name in the server hash table and if found returns the attribute for this. If not found returns NULL;

Prototype

AjBool ajNamServer (
      const AjPStr name
);

Type Name Read/Write Description

const AjPStr name Input character string find in hash table.

AjBool RETURN true if server name is valid.

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	character string find in hash table.
`AjBool`		RETURN	true if server name is valid.

From EMBOSS 6.4.0

Function ajNamDatabase

Looks for name in the database hash table and if found returns true.

Prototype

AjBool ajNamDatabase (
      const AjPStr name
);

Type Name Read/Write Description

const AjPStr name Input character string find in hash table.

AjBool RETURN true if database name is valid.

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	character string find in hash table.
`AjBool`		RETURN	true if database name is valid.

From EMBOSS 1.0.0

Function ajNamAliasDatabase

Looks for name in the database hash table and the database hash table and if found returns the true name for this. If not found returns NULL.

Prototype

AjBool ajNamAliasDatabase (
      AjPStr* Pname
);

Type Name Read/Write Description

AjPStr* Pname Modify character string to find in hash table.

AjBool RETURN true if database name is valid.

Type	Name	Read/Write	Description
`AjPStr*`	`Pname`	Modify	character string to find in hash table.
`AjBool`		RETURN	true if database name is valid.

From EMBOSS 6.4.0

Function ajNamDatabaseServer

Looks for a database name for a specific server. Reads the server cache file to find the database.

Prototype

AjBool ajNamDatabaseServer (
      const AjPStr name,
      const AjPStr server
);

Type Name Read/Write Description

const AjPStr name Input Database name to find for server

const AjPStr server Input Server name

AjBool RETURN true if database name is valid.

Type	Name	Read/Write	Description
`const AjPStr`	`name`	Input	Database name to find for server
`const AjPStr`	`server`	Input	Server name
`AjBool`		RETURN	true if database name is valid.

From EMBOSS 6.4.0

Function ajNamAliasServer

Looks for a database name for a specific server. Reads the server cache file to find the database.

Prototype

AjBool ajNamAliasServer (
      AjPStr* Pname,
      const AjPStr server
);

Type Name Read/Write Description

AjPStr* Pname Modify character string to find in hash table.

const AjPStr server Input Server name

AjBool RETURN true if database name is valid.

Type	Name	Read/Write	Description
`AjPStr*`	`Pname`	Modify	character string to find in hash table.
`const AjPStr`	`server`	Input	Server name
`AjBool`		RETURN	true if database name is valid.

From EMBOSS 6.4.0

Function ajNamSvrCount

Reads the database cachefile for a server and counts the number of databases

Prototype

ajuint ajNamSvrCount (
      const AjPStr server
);

Type Name Read/Write Description

const AjPStr server Input Server name

ajuint RETURN Number of databases

Type	Name	Read/Write	Description
`const AjPStr`	`server`	Input	Server name
`ajuint`		RETURN	Number of databases

From EMBOSS 6.4.0

Function ajNamSvrListListDatabases

Reads the database cachefile for a server and lists the databases.

Prototype

void ajNamSvrListListDatabases (
      const AjPStr server,
      AjPList dbnames
);

Type Name Read/Write Description

const AjPStr server Input Server name

AjPList dbnames Output Str List of names to be populated

void RETURN

Type	Name	Read/Write	Description
`const AjPStr`	`server`	Input	Server name
`AjPList`	`dbnames`	Output	Str List of names to be populated
`void`		RETURN

From EMBOSS 6.4.0

Function ajNamInit

Initialise the variable and database definitions. Find the definition files and read them.

Prototype

void ajNamInit (
      const char* prefix
);

Type Name Read/Write Description

const char* prefix Input Default prefix for all file and variable names.

void RETURN

Type	Name	Read/Write	Description
`const char*`	`prefix`	Input	Default prefix for all file and variable names.
`void`		RETURN

From EMBOSS 1.0.0

Function ajNamExit

Delete the initialisation values in the table.

Prototype

void ajNamExit (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 1.0.0

Function ajNamSvrTest

Looks for a server name in the known definitions.

Prototype

AjBool ajNamSvrTest (
      const AjPStr svrname
);

Type Name Read/Write Description

const AjPStr svrname Input Server name.

AjBool RETURN ajTrue on success.

Type	Name	Read/Write	Description
`const AjPStr`	`svrname`	Input	Server name.
`AjBool`		RETURN	ajTrue on success.

From EMBOSS 6.4.0

Function ajNamSvrGetUrl

Gets the URL definition for a server definition.

Prototype

AjBool ajNamSvrGetUrl (
      const AjPStr svrname,
      AjPStr* url
);

Type Name Read/Write Description

const AjPStr svrname Input Server name.

AjPStr* url Output URL returned.

AjBool RETURN ajTrue if success.

Type	Name	Read/Write	Description
`const AjPStr`	`svrname`	Input	Server name.
`AjPStr*`	`url`	Output	URL returned.
`AjBool`		RETURN	ajTrue if success.

From EMBOSS 6.4.0

Function ajNamQueryGetDatatypeC

Gets the datatype matching a query, and updates the datatype in the query

Prototype

const char* ajNamQueryGetDatatypeC (
      const AjPQuery qry
);

Type Name Read/Write Description

const AjPQuery qry Input Database query

const char* RETURN Database type

Type	Name	Read/Write	Description
`const AjPQuery`	`qry`	Input	Database query
`const char*`		RETURN	Database type

From EMBOSS 6.4.0

Function ajNamQueryGetUrl

Gets the URL definition for a server definition.

Prototype

const AjPStr ajNamQueryGetUrl (
      const AjPQuery qry
);

Type Name Read/Write Description

const AjPQuery qry Input Database query

const AjPStr RETURN URL value

Type	Name	Read/Write	Description
`const AjPQuery`	`qry`	Input	Database query
`const AjPStr`		RETURN	URL value

From EMBOSS 6.4.0

Function ajNamSvrGetDbalias

Gets alias names for a server's database.

Prototype

AjBool ajNamSvrGetDbalias (
      const AjPStr svrname,
      AjPStr* dbalias
);

Type Name Read/Write Description

const AjPStr svrname Input Server name.

AjPStr* dbalias Output Alias returned.

AjBool RETURN ajTrue if success.

Type	Name	Read/Write	Description
`const AjPStr`	`svrname`	Input	Server name.
`AjPStr*`	`dbalias`	Output	Alias returned.
`AjBool`		RETURN	ajTrue if success.

From EMBOSS 6.4.0

Function ajNamSvrData

Given a query with server name, database name and search fields, fill in the common fields. The query fields are set later.

Prototype

AjBool ajNamSvrData (
      AjPQuery qry,
      ajuint argc,
      ...
);

Type Name Read/Write Description

AjPQuery qry Modify Query structure with at least dbname filled in

ajuint argc Input Number of additional attribute name/value pairs

... vararg Vararg Variable length argument list

AjBool RETURN ajTrue if success.

Type	Name	Read/Write	Description
`AjPQuery`	`qry`	Modify	Query structure with at least dbname filled in
`ajuint`	`argc`	Input	Number of additional attribute name/value pairs
`...`	`vararg`	Vararg	Variable length argument list
`AjBool`		RETURN	ajTrue if success.

From EMBOSS 6.4.0

Function ajNamSvrQuery

Given a query with server name and search fields, fill in the access method and some common fields according to the query level.

Prototype

AjBool ajNamSvrQuery (
      AjPQuery qry
);

Type Name Read/Write Description

AjPQuery qry Modify Query structure with at least svrname filled in

AjBool RETURN ajTrue if success.

Type	Name	Read/Write	Description
`AjPQuery`	`qry`	Modify	Query structure with at least svrname filled in
`AjBool`		RETURN	ajTrue if success.

From EMBOSS 6.4.0

Function ajNamDbTest

Looks for a database name in the known definitions.

Prototype

AjBool ajNamDbTest (
      const AjPStr dbname
);

Type Name Read/Write Description

const AjPStr dbname Input Database name.

AjBool RETURN ajTrue on success.

Type	Name	Read/Write	Description
`const AjPStr`	`dbname`	Input	Database name.
`AjBool`		RETURN	ajTrue on success.

From EMBOSS 1.0.0

Function ajNamDbGetType

Gets the enumerated type for a database definition.

Prototype

AjBool ajNamDbGetType (
      const AjPStr dbname,
      ajuint* itype
);

Type Name Read/Write Description

const AjPStr dbname Input Database name.

ajuint* itype Output Database enumerated type

AjBool RETURN ajTrue if success.

Type	Name	Read/Write	Description
`const AjPStr`	`dbname`	Input	Database name.
`ajuint*`	`itype`	Output	Database enumerated type
`AjBool`		RETURN	ajTrue if success.

From EMBOSS 6.4.0

Function ajNamDbGetUrl

Gets the URL definition for a database definition.

Prototype

AjBool ajNamDbGetUrl (
      const AjPStr dbname,
      AjPStr* url
);

Type Name Read/Write Description

const AjPStr dbname Input Database name.

AjPStr* url Output URL returned.

AjBool RETURN ajTrue if success.

Type	Name	Read/Write	Description
`const AjPStr`	`dbname`	Input	Database name.
`AjPStr*`	`url`	Output	URL returned.
`AjBool`		RETURN	ajTrue if success.

From EMBOSS 1.0.0

Function ajNamDbGetDbalias

Gets an alias name for a database.

Prototype

AjBool ajNamDbGetDbalias (
      const AjPStr dbname,
      AjPStr* dbalias
);

Type Name Read/Write Description

const AjPStr dbname Input Database name.

AjPStr* dbalias Output Alias returned.

AjBool RETURN ajTrue if success.

Type	Name	Read/Write	Description
`const AjPStr`	`dbname`	Input	Database name.
`AjPStr*`	`dbalias`	Output	Alias returned.
`AjBool`		RETURN	ajTrue if success.

From EMBOSS 1.0.0

Function ajNamDbGetIndexdir

Gets the index directory for a database.

Prototype

AjBool ajNamDbGetIndexdir (
      const AjPStr dbname,
      AjPStr* indexdir
);

Type Name Read/Write Description

const AjPStr dbname Input Database name.

AjPStr* indexdir Output Directory path returned.

AjBool RETURN ajTrue if success.

Type	Name	Read/Write	Description
`const AjPStr`	`dbname`	Input	Database name.
`AjPStr*`	`indexdir`	Output	Directory path returned.
`AjBool`		RETURN	ajTrue if success.

From EMBOSS 6.4.0

Function ajNamQuerySetDbalias

Sets an alias name for a database query.

Prototype

AjBool ajNamQuerySetDbalias (
      AjPQuery qry
);

Type Name Read/Write Description

AjPQuery qry Modify Database query.

AjBool RETURN ajTrue if success.

From EMBOSS 6.4.0

Function ajNamDbData

Given a query with database name and search fields, fill in the common fields. The query fields are set later.

Prototype

AjBool ajNamDbData (
      AjPQuery qry,
      ajuint argc,
      ...
);

From EMBOSS 2.4.0

Function ajNamDbQuery

Given a query with database name and search fields, fill in the access method and some common fields according to the query level.

Prototype

AjBool ajNamDbQuery (
      AjPQuery qry
);

Type Name Read/Write Description

AjPQuery qry Modify Query structure with at least dbname filled in

AjBool RETURN ajTrue if success.

From EMBOSS 1.0.0

Function ajNamFileQuery

Given a query with no database name and search fields, check datatype specific fields according to the query level.

Prototype

AjBool ajNamFileQuery (
      AjPQuery qry
);

Type Name Read/Write Description

AjPQuery qry Modify Query structure with no database name

AjBool RETURN ajTrue if success.

From EMBOSS 6.4.0

Function ajNamValueInstalldir

Returns the install directory root for all file searches (package level)

Prototype

const AjPStr ajNamValueInstalldir (
      void
);

Type Name Read/Write Description

const AjPStr RETURN Install directory root

From EMBOSS 6.0.0

Function ajNamValuePackage

Returns the package name for the library

Prototype

const AjPStr ajNamValuePackage (
      void
);

Type Name Read/Write Description

const AjPStr RETURN Package name

From EMBOSS 6.0.0

Function ajNamValueSystem

Returns the system information for the library

Prototype

const AjPStr ajNamValueSystem (
      void
);

Type Name Read/Write Description

const AjPStr RETURN Version number

From EMBOSS 6.2.0

Function ajNamValueVersion

Returns the version number for the library

Prototype

const AjPStr ajNamValueVersion (
      void
);

Type Name Read/Write Description

const AjPStr RETURN Version number

From EMBOSS 6.0.0

Function ajNamValueRootdir

Returns the directory for all file searches (package level)

Prototype

const AjPStr ajNamValueRootdir (
      void
);

Type Name Read/Write Description

const AjPStr RETURN Package level root directory

From EMBOSS 6.0.0

Function ajNamValueBasedir

Returns the base directory for all for all file searches (above package level).

Prototype

const AjPStr ajNamValueBasedir (
      void
);

Type Name Read/Write Description

const AjPStr RETURN Base directory

From EMBOSS 6.0.0

Function ajNamResolve

Resolves a variable name if the input string starts with a dollar sign.

Prototype

AjBool ajNamResolve (
      AjPStr* name
);

Type Name Read/Write Description

AjPStr* name Output String

AjBool RETURN ajTrue on success.

From EMBOSS 1.0.0

Function ajNamSetControl

Sets special internal variables to reflect their presence.

Prototype

AjBool ajNamSetControl (
      const char* optionName
);

Type Name Read/Write Description

const char* optionName Input option name

AjBool RETURN ajTrue if option was recognised

From EMBOSS 2.7.0

Function ajNamRsAttrValueC

Return the value for a resource attribute

Prototype

AjBool ajNamRsAttrValueC (
      const char* name,
      const char* attribute,
      AjPStr* value
);

Type Name Read/Write Description

const char* name Input resource name

const char* attribute Input resource attribute

AjPStr* value Output resource value

AjBool RETURN true if found

From EMBOSS 3.0.0

Function ajNamRsAttrValueS

Return the value for a resource attribute

Prototype

AjBool ajNamRsAttrValueS (
      const AjPStr name,
      const AjPStr attribute,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input resource name

const AjPStr attribute Input resource attribute

AjPStr* value Output resource value

AjBool RETURN true if found

From EMBOSS 6.4.0

Function ajNamRsListValue

Return the value for a resource attribute of type 'list'

Prototype

AjBool ajNamRsListValue (
      const AjPStr name,
      AjPStr* value
);

Type Name Read/Write Description

const AjPStr name Input resource name

AjPStr* value Output resource value

AjBool RETURN true if found

From EMBOSS 3.0.0

Type	Name	Read/Write	Description
`const char*`	`optionName`	Input	option name
`AjBool`		RETURN	ajTrue if option was recognised