API Reference

Table of Contents

I. Functions

asc - finds the ASCII value of a string character

chr - return a character with a given ASCII value

clearsession - clears a single session variable, or all session variables

error - get/set the RSP error message

getdatasources - enumerate available data sources

header - send raw HTTP headers

hex - convert an integer to an hexadecimal string

htmlencode - convert special characters to HTML entities

lower - convert a string to lower case

ltrim - remove leading whitespace

oct - convert an integer to an octal string

pad - pad a string up to a specified length

padleft - prefix a string up to a specified length

print - send text to the response

random - generates a random number

repeat - repeat a string

request - retrieve form data

rtrim - remove trailing whitespace

session - read a session variable

sessionkeys - returns an array of all the session variable names

setsession - set a session variable

strlen - finds the length of a string

substr - extract a portion of a string

translate - convert an RSP page name into a page name in the target language

trim - remove leading and trailing whitespace

upper - convert a string to upper case

urlencode - convert non-alphanumerics to URL encoded escape sequences

II. The Array Pseudo-Object

Array.length - find the length of an array

Array.resize - find the length of an array

III. The Connection Object

Connection - open a database connection

close - close a database connection

Connection.execute - execute an SQL update query

Connection.getmetacolumn - get the names of columns in meta data recordsets

Connection.isselect - determine if an SQL statement is a select or an update

Connection.openrs - execute an SQL select statement and return the recordset

Connection.opentablesrs - get a list of database tables

IV. The Recordset Object

Recordset.close - close an open recordset

Recordset.eof - determine if the cursor is after the last record

Recordset.fieldname - get the name of a particular field

Recordset.getstring - get the value of a particular field as a string

Recordset.goto - jump to a particular row in a recordset

Recordset.isnull - determine if a field contains SQL NULL

Recordset.next - move the recordset cursor on to the next row of the recordset

Recordset.numfields - get the number of fields in a recordset

Recordset.row - get the current row index

Recordset.rows - get the number of rows in the recordset

V. Constants

Database Type Constants - string constants for database types

Meta Column Constants - constants for database meta information columns

Script Constants - general constants available to running scripts