ajurl.c

Datatypes:
AjPUrl Url data
none Miscellaneous functions


Datatype: AjPUrl

Function is for manipulating url data objects

Sections:
constructorsConstructors
Url data destructorsDestructors
CastsCasts
url data modifiersModifiers


AjPUrl: constructors

Constructors

Functions:
ajUrlNewUrl data constructor


Function ajUrlNew

Url data constructor

Prototype

AjPUrl ajUrlNew (
      void
);

TypeNameRead/WriteDescription
AjPUrl RETURNNew object

From EMBOSS 6.4.0


AjPUrl: Url data destructors

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

Functions:
ajUrlDelUrl data destructor


Function ajUrlDel

Url data destructor

Prototype

void ajUrlDel (
      AjPUrl* Purl
);

TypeNameRead/WriteDescription
AjPUrl*PurlDeleteUrl data object to delete
void RETURN

From EMBOSS 6.4.0


AjPUrl: Casts

Return values from an url data object

Functions:
ajUrlGetDbReturn the database name
ajUrlGetIdReturn the identifier
ajUrlGetQryCReturns the query string of an url 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.
ajUrlGetQrySReturns the query string of an url 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 ajUrlGetDb

Return the database name

Prototype

const AjPStr ajUrlGetDb (
      const AjPUrl url
);

TypeNameRead/WriteDescription
const AjPUrlurlInputUrl
const AjPStr RETURNDatabase name

From EMBOSS 6.4.0


Function ajUrlGetId

Return the identifier

Prototype

const AjPStr ajUrlGetId (
      const AjPUrl url
);

TypeNameRead/WriteDescription
const AjPUrlurlInputUrl
const AjPStr RETURNReturned id

From EMBOSS 6.4.0


Function ajUrlGetQryC

Returns the query string of an url 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* ajUrlGetQryC (
      const AjPUrl url
);

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

From EMBOSS 6.4.0


Function ajUrlGetQryS

Returns the query string of an url 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 ajUrlGetQryS (
      const AjPUrl url
);

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

From EMBOSS 6.4.0


AjPUrl: url data modifiers

Url data modifiers

Functions:
ajUrlClearResets all data for an url data object so that it can be reused.


Function ajUrlClear

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

Prototype

void ajUrlClear (
      AjPUrl url
);

TypeNameRead/WriteDescription
AjPUrlurlModifyUrl data object
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:
ajUrlExitCleans up url processing internal memory


Function ajUrlExit

Cleans up url processing internal memory

Prototype

void ajUrlExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0