ajurl.c

Datatypes: AjPUrl none

Datatype: AjPUrl

Url data

Sections: constructors Url data destructors Casts url data modifiers

Section: constructors

Constructors

Functions: ajUrlNew

Function ajUrlNew

Url data constructor

Synopsis

Prototype
AjPUrl ajUrlNew (
      void
);

TypeNameRead/WriteDescription
AjPUrl RETURNNew object

Returns
AjPUrl:New object

Description

Url data constructor

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Url data destructors

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

Functions: ajUrlDel

Function ajUrlDel

Url data destructor

Synopsis

Prototype
void ajUrlDel (
      AjPUrl* Purl
);

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

Output
Purl:(Delete)Url data object to delete
Returns
void:No return value

Description

Url data destructor

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Casts

Return values from an url data object

Functions: ajUrlGetDb ajUrlGetId ajUrlGetQryC ajUrlGetQryS

Function ajUrlGetDb

Return the database name

Synopsis

Prototype
const AjPStr ajUrlGetDb (
      const AjPUrl url
);

TypeNameRead/WriteDescription
const AjPUrlurlInputUrl
const AjPStr RETURNDatabase name

Input
url:(Input)Url
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 ajUrlGetId

Return the identifier

Synopsis

Prototype
const AjPStr ajUrlGetId (
      const AjPUrl url
);

TypeNameRead/WriteDescription
const AjPUrlurlInputUrl
const AjPStr RETURNReturned id

Input
url:(Input)Url
Returns
const AjPStr:Returned id

Description

Return the identifier

See Also

See other functions in this section

Availability

In release 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.

Synopsis

Prototype
const char* ajUrlGetQryC (
      const AjPUrl url
);

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

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

Description

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.

See Also

See other functions in this section

Availability

In release 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.

Synopsis

Prototype
const AjPStr ajUrlGetQryS (
      const AjPUrl url
);

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

Input
url:(Input)Url data object.
Returns
const AjPStr:Query as a string.

Description

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.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: url data modifiers

Url data modifiers

Functions: ajUrlClear

Function ajUrlClear

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

Synopsis

Prototype
void ajUrlClear (
      AjPUrl url
);

TypeNameRead/WriteDescription
AjPUrlurlModifyUrl data object
void RETURN

Input & Output
url:(Modify)Url data object
Returns
void:No return value

Description

Resets all data for an url 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: ajUrlExit

Function ajUrlExit

Cleans up url processing internal memory

Synopsis

Prototype
void ajUrlExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up url processing internal memory

See Also

See other functions in this section

Availability

In release 6.4.0