IMPORTING DATA

timport -s <schema>  <datafiles>

[more about: Timport] [^top^]

MIME API

varchar headerDecode(varchar header)

Parameters:

• header - A raw varchar header value

Returns:

• The unfolded and decoded varchar header value

See also: headerGetItems

[more about: headerDecode] [^top^]

varchar headerGetItems(varchar header)

Parameters:

• header - A raw varchar header value

Returns:

• The raw (original encoded) list of CSV items, as a varstrlst

See also: headerDecode, headerItemGetParameterValues

[more about: headerGetItems] [^top^]

varstrlst headerItemGetParameterNames(varchar headerItem)

Parameters:

• headerItem - A varchar raw header item

Returns:

• The varstrlst decoded list of parameter names

See also: headerItemGetParameterValues, mimeEntityGetHeaderParameterNames

[more about: headerItemGetParameterNames] [^top^]

varstrlst headerItemGetParameterValues(varchar headerItem
                                      [, varchar paramName])

Parameters:

• headerItem - A varchar raw header item

• paramName - An optional varchar parameter name

Returns:

• The varstrlst decoded list of parameter values

See also: headerItemGetParameterNames, mimeEntityGetHeaderParameterValues

[more about: headerItemGetParameterValues] [^top^]

varchar headerMailboxGetAddress(varchar mailbox)

Parameters:

• mailbox - A varchar mailbox (with address and/or display name)

Returns:

• The decoded varchar email address

See also: headerMailboxGetDisplayName

[more about: headerMailboxGetAddress] [^top^]

varchar headerMailboxGetDisplayName(varchar mailbox)

Parameters:

• mailbox - A varchar mailbox (with address and/or display name)

Returns:

• The decoded varchar display name

See also: headerMailboxGetAddress

[more about: headerMailboxGetDisplayName] [^top^]

varbyte mimeEntityGetBody(mimeEntity entityOrReader[, varchar flags])

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

• flags - An optional CSV list of flags:

  • "reparented" - Re-parent HTML if appropriate

Returns:

• The decoded varbyte body of the entity

See also: mimeEntityGetSafeFilename, mimeEntityGetText

[more about: mimeEntityGetBody] [^top^]

int mimeEntityGetChildNumber(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int child number of the entity

See also: mimeEntityGetImapSectionSpecification, mimeEntityIsLastChild, mimeEntityGetSequenceNumber

[more about: mimeEntityGetChildNumber] [^top^]

varchar mimeEntityGetContentLocation(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• The varchar content location URL of the entity

[more about: mimeEntityGetContentLocation] [^top^]

int mimeEntityGetDepth(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int depth of the entity from root

See also: mimeEntityGetChildNumber

[more about: mimeEntityGetDepth] [^top^]

varstrlst mimeEntityGetHeaderNames(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• varstrlst list of header names

See also: mimeEntityGetHeaderValues

[more about: mimeEntityGetHeaderNames] [^top^]

varstrlst mimeEntityGetHeaderParameterNames(mimeEntity entityOrReader,
                                            varchar headerName)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

• headerName - The varchar name of the header

Returns:

• varstrlst list of parameter names for header

See also: mimeEntityGetHeaderParameterValues

[more about: mimeEntityGetHeaderParameterNames] [^top^]

varstrlst mimeEntityGetHeaderParameterValues(mimeEntity entityOrReader,
                                varchar headerName[, varchar paramName])

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

• headerName - The varchar name of the header

• paramName - The optional varchar name of the parameter

Returns:

• varstrlst list of parameter values from header for given parameter name

See also: mimeEntityGetHeaderParameterNames

[more about: mimeEntityGetHeaderParameterValues] [^top^]

varstrlst mimeEntityGetHeaderValues(mimeEntity entityOrReader,
                                    varchar headerName)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

• headerName - The varchar name of the header

Returns:

• varstrlst list of decoded value(s) of given header name

See also: mimeEntityGetHeaderNames, mimeEntityGetHeaderParameterValues

[more about: mimeEntityGetHeaderValues] [^top^]

varchar mimeEntityGetImapSectionSpecification(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• varchar IMAP section specification

See also: mimeEntityGetChildNumber

[more about: mimeEntityGetImapSectionSpecification] [^top^]

varchar mimeEntityGetMessageFilename(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• varchar filename for the entity, as specified in the message

See also: mimeEntityGetSafeFilename

[more about: mimeEntityGetMessageFilename] [^top^]

varchar mimeEntityGetRawBody(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• varchar raw (original encoded) body of entity

See also: mimeEntityGetBody

[more about: mimeEntityGetRawBody] [^top^]

int64 mimeEntityGetRawBodyOffset(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int64 byte offset of raw (original encoded) body in message

See also: mimeEntityGetBody

[more about: mimeEntityGetRawBodyOffset] [^top^]

int64 mimeEntityGetRawBodySize(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int64 byte size of raw (original encoded) body in message

See also: mimeEntityGetBody

[more about: mimeEntityGetRawBodySize] [^top^]

varchar mimeEntityGetRawHeaderSection(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• varchar raw (original encoded) header section of entity

See also: mimeEntityGetHeaderValues

[more about: mimeEntityGetRawHeaderSection] [^top^]

int64 mimeEntityGetRawHeaderSectionOffset(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int64 byte offset of raw (original encoded) header section of entity in message

See also: mimeEntityGetHeaderValues

[more about: mimeEntityGetRawHeaderSectionOffset] [^top^]

int64 mimeEntityGetRawHeaderSectionSize(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int64 byte size of raw (original encoded) header section of entity

See also: mimeEntityGetHeaderValues

[more about: mimeEntityGetRawHeaderSectionSize] [^top^]

varstrlst mimeEntityGetRawHeaderValues(mimeEntity entityOrReader,
                                       varchar headerName)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

• headerName - The varchar name of the header

Returns:

• varchar raw (original encoded) header named `headerName`

See also: mimeEntityGetHeaderValues

[more about: mimeEntityGetRawHeaderValues] [^top^]

varchar mimeEntityGetSafeFilename(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• varchar filename for entity, safe for filesystem

See also: mimeEntityGetMessageFilename

[more about: mimeEntityGetSafeFilename] [^top^]

int mimeEntityGetSequenceNumber(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int sequence number for the entity

See also: mimeEntityGetChildNumber

[more about: mimeEntityGetSequenceNumber] [^top^]

varchar mimeEntityGetText(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• varchar formatted text of the entity's body

See also: mimeEntityGetBody

[more about: mimeEntityGetText] [^top^]

varchar mimeEntityGetTextCharset(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• varchar charset of mimeEntityGetText return data

See also: mimeEntityGetText

[more about: mimeEntityGetTextCharset] [^top^]

varchar mimeEntityGetTextFormatter(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• varchar token indicating text formatter used for body text

See also: mimeEntityGetText

[more about: mimeEntityGetTextFormatter] [^top^]

int mimeEntityIsLastChild(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int boolean value indicating whether entity is the last child of its parent

See also: mimeEntityGetChildNumber

[more about: mimeEntityIsLastChild] [^top^]

int mimeEntityIsReparented(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int boolean value indicating whether the mimeEntityGetBody value is reparented (if reparenting requested)

See also: mimeEntityGetBody

[more about: mimeEntityIsReparented] [^top^]

int mimeEntityIsStartBodyPart(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int boolean value indicating whether the entity is the overall message start part

See also: mimeEntityGetSafeFilename

[more about: mimeEntityIsStartBodyPart] [^top^]

mimeEntity mimeReaderGetEntity(mimeReader reader)

Parameters:

• reader - A mimeReader object

Returns:

• mimeEntity object for current entity

See also: mimeReaderGetFullEntity

[more about: mimeReaderGetEntity] [^top^]

mimeEntity mimeReaderGetFullEntity(mimeReader reader)

Parameters:

• reader - A mimeReader object

Returns:

• mimeEntity object for entire entity tree at cursor

See also: mimeReaderGetEntity, mimeReaderOpenEntity

[more about: mimeReaderGetFullEntity] [^top^]

int mimeReaderMoveToNextEntity(mimeReader reader)

Parameters:

• reader - A mimeReader object

Returns:

• int value: 1 on success, 0 on EOF, -1 on error

See also: mimeReaderMoveToNextEntitySibling

[more about: mimeReaderMoveToNextEntity] [^top^]

int mimeReaderMoveToNextEntitySibling(mimeReader reader)

Parameters:

• reader - A mimeReader object

Returns:

• int value: 1 on success, 0 on EOF, -1 on error

See also: mimeReaderMoveToNextEntity

[more about: mimeReaderMoveToNextEntitySibling] [^top^]

mimeReader mimeReaderOpenEntity(mimeEntity entityOrReader
                               [, int64 maxDepth[, varchar flags]])

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

• maxDepth - An optional integer maximum depth to parse to

• flags - An optional CSV list of flags:

  • "inherittreeposition" - Continue with same depth, IMAP number, etc. of parent entityOrReader

Returns:

• mimeReader object

See also: mimeReaderOpenFile

[more about: mimeReaderOpenEntity] [^top^]

mimeReader mimeReaderOpenFile(varchar file[, int64 maxDepth])

Parameters:

• file - A varchar path to the MIME file to open

• maxDepth An optional integer maximum depth to parse to

Returns:

• mimeReader object for parsing the file

See also: mimeReaderOpenString

[more about: mimeReaderOpenFile] [^top^]

mimeReader mimeReaderOpenString(varchar string[, int64 maxDepth])

Parameters:

• string - A varchar string with the MIME message

• maxDepth An optional integer maximum depth to parse to

Returns:

• mimeReader object for parsing the message

See also: mimeReaderOpenFile

[more about: mimeReaderOpenString] [^top^]

refInfo API

varchar refInfoGetAttribute(refInfo ref, varchar attrName)

Parameters:

• ref - A refInfo object

• attrName - The varchar name of the attribute to get

Returns:

• The varchar value of the named attribute, HTML decoded, in UTF-8.

See also: refInfoGetAttributes

[more about: refInfoGetAttribute] [^top^]

varstrlst refInfoGetAttributes(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varstrlst list of attribute names for the reference.

See also: refInfoGetAttribute, refInfoGetTagName

[more about: refInfoGetAttributes] [^top^]

varchar refInfoGetDescription(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varchar human description of the reference.

See also: refInfoGetTypes, refInfoGetFlags

[more about: refInfoGetDescription] [^top^]

varstrlst refInfoGetFlags(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varstrlst list of flags for the reference

Flags may be zero or more of:

• dynamic The reference was created dynamically, i.e. via JavaScript. The reference may have been directly created by a script - e.g. setting document.location - or indirectly - e.g. via document.write('<a href="link.html">link</a>').

See also: refInfoGetTypes, refInfoGetTagName

[more about: refInfoGetFlags] [^top^]

varchar refInfoGetLinkText(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varchar link text for the reference, i.e. the visible text a user would click on to follow it, HTML decoded, in UTF-8

See also: refInfoGetAttributes

[more about: refInfoGetLinkText] [^top^]

int64 refInfoGetProcessedDocLength(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The int64 character length of the reference's element in the processed document (HTML)

See also: refInfoGetRawDocLength

[more about: refInfoGetProcessedDocLength] [^top^]

int64 refInfoGetProcessedDocOffset(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The int64 character offset of the reference's element in the processed document (HTML)

See also: refInfoGetRawDocOffset

[more about: refInfoGetProcessedDocOffset] [^top^]

int64 refInfoGetRawDocLength(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The int64 character length of the reference's element in the raw document (HTML)

See also: refInfoGetProcessedDocLength

[more about: refInfoGetRawDocLength] [^top^]

int64 refInfoGetRawDocOffset(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The int64 character offset of the reference's element in the raw document (HTML)

See also: refInfoGetProcessedDocOffset

[more about: refInfoGetRawDocOffset] [^top^]

varchar refInfoGetSourceAttribute(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varchar name of the HTML attribute of the tag that signified it as a reference

See also: refInfoGetTagName

[more about: refInfoGetSourceAttribute] [^top^]

varchar refInfoGetStrBaseUrl(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varchar JavaScript base URL of the reference, if any.

[more about: refInfoGetStrBaseUrl] [^top^]

varchar refInfoGetTagName(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varchar name of the HTML tag that signifies it as a reference

See also: refInfoGetSourceAttribute

[more about: refInfoGetTagName] [^top^]

int64 refInfoGetTextLength(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The int64 character length of the reference's formatted text span.

See also: refInfoGetProcessedDocLength

[more about: refInfoGetTextLength] [^top^]

int64 refInfoGetTextOffset(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The int64 character offset of the reference's element in the formatted text

See also: refInfoGetProcessedDocOffset

[more about: refInfoGetTextOffset] [^top^]

varstrlst refInfoGetTypes(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varstrlst list of one or more types for the reference

Types may be one or more of:

• link

• image

• frame

• iframe

• strlink

See also: refInfoGetTagName

[more about: refInfoGetTypes] [^top^]

varchar refInfoGetUrl(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varchar URL (link) of the reference

[more about: refInfoGetUrl] [^top^]

SQL COMMANDS

ALTER USER user-name IDENTIFIED BY password

Changes user-name's password to password. You must be logged in as that user or _SYSTEM to perform this operation.

[more about: ALTER USER] [^top^]

CREATE [UNIQUE] | {[METAMORPH] [INVERTED | COUNTER]} INDEX index-name

  ON table-name

  (column-name1 [DESC]

  [, column-name2 [DESC] ] ...)

See also: Virtual Fields

[more about: CREATE INDEX] [^top^]

CREATE TABLE table-name

  (column-name1 data-type 

  [, column-name2 data-type ] ...)

[more about: CREATE TABLE ] [^top^]

CREATE TABLE table-name AS 
  
  SELECT  {expression1 [, expression2]...}{...}

  FROM  table-name1 [alias1] [, table-name2 [alias2] ]...

  [WHERE     search-condition]

  [GROUP BY  column-name1 [, column-name2]...

  [ORDER BY  column-name3 [DESC] [, column-name4  [DESC] ] ...]

[more about: CREATE TABLE AS (ALTER TABLE) ] [^top^]

CREATE USER user-name IDENTIFIED BY password

Creates a new user with the specified user-name and password.

[more about: CREATE USER] [^top^]

DELETE FROM table-name

  [WHERE search-condition]

[more about: DELETE FROM] [^top^]

DROP INDEX index-name

[more about: DROP INDEX] [^top^]

DROP TABLE table-name

[more about: DROP TABLE] [^top^]

DROP USER user-name

[more about: DROP USER] [^top^]

GRANT  {ALL}

       {privilege1 [,privilege2]...}

  ON   {table-name}

       {view-name}

  TO   {PUBLIC}

       {userid1 [,userid2]...}

See also: REVOKE, SYSUSERS system table, CHMOD(1), CHOWN(1)

[more about: GRANT PERMISSIONS] [^top^]

INSERT INTO table-name[(col-name1 [, col-name2]...)]

  VALUES(value1 [, value2]...)

[more about: INSERT INTO (new rows)] [^top^]

INSERT INTO table-name[(col-name1 [, col-name2]...)]

  SELECT-statement

[more about: INSERT INTO (selected rows)] [^top^]

SELECT [DISTINCT] {expression1 [[AS] alias1] [, expression2 [[AS alias2]]...}{...}

  FROM  table-name1 [alias1] [, table-name2 [alias2] ]...

  [WHERE      search-condition]

  [GROUP BY   column-name1 [, column-name2]...

  [HAVING     search-condition]]

  [ORDER BY   column-name3 [DESC] [, column-name4  [DESC] ] ...]

See also: Text Queries

[more about: SELECT ] [^top^]

UPDATE table-name

 SET column-name1 = expression1

  [, column-name2 = expression2]...

 [WHERE search-condition]

[more about: UPDATE] [^top^]

    string xmlReaderGetAttribute(xmlReader reader, string name
    [, string nsURI])

Parameters:

• xmlReader - the xmlReader object

• name - the name of the attribute whose value you want

• nsURI (optional) - The URI or the namespace for the attribute. Defaults to any namespace.

Returns:

• The value of the attribute.

See also: xmlReaderGetAttribute xmlReaderGetAttributeCount xmlReaderGetAttributeNumber

[more about: xmlReaderGetAttribute] [^top^]

SQL REFERENCE

[more about: Aggregate Functions] [^top^]

The first is that Texis WebScript will name the variable the same as the column name. If the default name of the column would be an illegal name, or would conflict with an existing variable, renaming the column lets you change the variable name at the same time.

The second situation is within the query itself. If you have a GROUP BY clause with either a HAVING clause or an ORDER BY clause, then any aggregate or calculated fields must be aliased, and the alias name used in the HAVING or ORDER BY clause. This is the only time the alias name can be used in the query.

[more about: Column Aliasing] [^top^]

<EXPORT $nquery>
.
.
<SQL "select Body, text2mm(Body) nquery from ...">
$Body
<A HREF=$url/morelike.html>Find Similar</A>
</SQL>

<A NAME=morelike>
<SQL "select id, Title from ... WHERE Body LIKEP $nquery">
<showrow>
</SQL>
</A>

[more about: Document Similarity] [^top^]

SELECT cust.name, orders.text FROM cust,orders WHERE
       cust.name = 'John Doe' and orders.custid = cust.id;

[more about: Join Order] [^top^]

• Integers
• Floating point numbers
• Character Strings

The range available in the numeric literals is machine dependent. You can typically count on at least the range in a long or double respectively.

Character strings are delimited by single quotes. To include a single quote in a string it should be doubled. For example:

'He''s one of us now.'

[more about: Literals] [^top^]

[more about: SQL functions.] [^top^]

The second, and more interesting use, is that it allows a table to be joined to itself. One example of this would be to generate a listing of employees and bosses.

SELECT boss.name Boss, emp.name Employee
    FROM employees emp, employees boss
    WHERE boss.id = emp.boss_id

[more about: Table Aliasing] [^top^]

SET property = value

Properties that affect Metamorph indices are kept with the index and do not need to be respecified. If you want to change the properties of an index you will need to drop it and re-create it. If searching must be maintained you can create a new index first with a different name, and then drop the old index.

[more about: Texis properties] [^top^]

The WHERE clause will affect which rows are selected from the table to be grouped. The HAVING clause will determine which groups are actually returned.

For example the query:

SELECT DEPT, AVG(SALARY) AVSAL FROM EMPLOYEES
       WHERE SALARY > 50000
       GROUP BY DEPT

SELECT DEPT, AVG(SALARY) AVSAL FROM EMPLOYEES
       GROUP BY DEPT
       HAVING AVSAL > 50000

[more about: WHERE vs. HAVING] [^top^]

TEXIS WEBSCRIPT

<A NAME=name [PUBLIC | EXPORT | PRIVATE] [param[=value|$var] ...]>
  ... statements ...
</A>

Defines a script function with given NAME. params are local to the function; if not passed arguments at call time, they are initialized to no-values or the given value or global $var, even if start function. params with no defaults must be given args at call time (except if start function).

[more about: A] [^top^]

<abstract $text [$maxsz [$style [$query]]]>

Generates an abstract from $text. Abstract will be at most $maxsz characters (default 230). $query is a Metamorph query to search for and focus abstract on. $style is one of:

Default is smart if neither $style nor $query given.

abstract returns an abstract for each of the supplied texts.

[more about: abstract] [^top^]

<addtrailingslash = yes|no>

Whether to add a trailing slash (via a redirect) when the script is accessed via a "directory" URL without a trailing slash, e.g. /texis/dir/script becomes /texis/dir/script/.

See also: [Texis] Vortex Add Trailing Slash setting in texis.ini

[more about: ADDTRAILINGSLASH] [^top^]

<adminsql [options ...] [statement ...]>

Execute an arbitrary SQL statement, the concatenation of statement args. SKIP=n and MAX=n can be given as leading options. No embedded Vortex variable parameters. Results printed in an HTML <table>.

adminsql returns nothing.

See also: SQL, createdb

[more about: adminsql] [^top^]

<apicp $name $value [$value ...]>

Modify Metamorph control parameters. Boolean settings take on, true or yes to turn on, opposite to turn off. Defaults for these can be set in texis.ini [Apicp] section.

Query protection settings:

querysettings values:

Query processing settings:

[more about: apicp] [^top^]

<apiinfo $setting>

Returns current value(s) for <apicp> single-setting $setting. $setting may also be "settings" to return list of all setting names.

See also: apicp

[more about: apiinfo] [^top^]

<BREAK>

Exits the innermost enclosing looping statement (WHILE, LOOP etc.). $loop/$next are unchanged.

See also: CONTINUE

[more about: BREAK] [^top^]

<cal [options] [$dates [$events [$var ...]]][ /]> [</cal>]

Print an HTML calendar of events with links. $dates are the dates, $events are corresponding text to print. In looping syntax, programmer must print each day's <td>, text and </td>.

See also: calrule

[more about: cal] [^top^]

<caldate $varprefix>

The caldate function returns a list of dates from the variables submitted by a form created with calendar. The value(s) of $varprefix are the variable prefix(es) given to calendar.

See also: calendar

[more about: caldate] [^top^]

<calendar $yr $month $day $hour $min ["am"|"pm" [$prefix [flags ...]]]>
<calendar $date [$prefix [flags ...]]>

Note: The calendar function is obsolescent. Use cal instead.

Prints a calendar HTML form. Submitted date(s) can be read with caldate.

calendar returns nothing.

See also: caldate

[more about: calendar] [^top^]

<calrule [options] [RULE=]$rule[ /]> [</calrule>]

Translates a vCalendar or English calendar rule and returns the Texis date(s) matching the rule. With </calrule>, loops over the date(s), and $loop and $next are set.

See also: cal, SCHEDULE

[more about: calrule] [^top^]

<CAPTURE [flags]>
  ... Vortex code ...
</CAPTURE>

CAPTURE returns the standard output of the Vortex code within the block, as one value.

See also: EXEC

[more about: CAPTURE] [^top^]

<checkbox $name $values $selected $output
          [$classes [$ids [$titles]]]>

Prints HTML checkbox for each $output value. $name is the name for the checkboxes, $values are the values. $values matching any of the $selected values are pre-checked. $classes gives CSS classes to assign, $id gives id attributes, $titles gives titles (i.e. hover text).

checkbox returns nothing.

See also: options, radiobutton

[more about: checkbox] [^top^]

<clist $values>

clist returns the $values in one parenthetical, comma-separated value, or an empty string if there are no values.

See also: slist

[more about: clist] [^top^]

<code2geo $num>

code2geo returns a string, the space-separated latitude and longitude for the given geo2code-encoded number.

See also: <geo2code> Vortex function, geocode2lat(), geocode2lon() SQL functions

[more about: code2geo] [^top^]

<CONTINUE>

Continues the innermost enclosing looping statement (WHILE, LOOP etc.) at the start of its next iteration. $loop/$next are incremented as usual.

See also: BREAK

[more about: CONTINUE] [^top^]

<COOKIES urldecode|asis>

Whether to URL-decode (or leave as-is) the value of cookes when importing into Vortex variables. The default is urldecode.

See also: [Texis] Cookies setting of texis.ini

[more about: COOKIES] [^top^]

<count $var>

count returns the (integer) number of values the $var variable has.

[more about: count] [^top^]

<createdb $db $syspass $publicpass>

The createdb function creates a new database whose path is given by $db. The passwords for _SYSTEM and PUBLIC are given as arguments. For security, the _SYSTEM password $syspass is required to be at least 6 characters and contain punctuation. The PUBLIC password $publicpass may be empty.

createdb returns "Creating database succeeded" on success, or "Creating database failed" or nothing on error.

See also: adminsql

[more about: createdb] [^top^]

<DB = "path">

As a directive (before any functions), sets default database for SQL statements, state table. As a statement (inside a function), sets current database for <sql> statements. Default if not set is from texis.ini, or texis/testdb in install dir.

See also: SQL, vxinfo

[more about: DB] [^top^]

<decrypt $crypt $key>

decrypt returns each value of Unix-style encrypted data $crypt, decrypted using key $key.

See also: encrypt, pwencrypt

[more about: decrypt] [^top^]

<doctype $langver [$type]>

doctype prints a <!DOCTYPE> declaration based on $langver and $type.

$langver values:

$type values:

doctype returns 1 on success, or 0 on error.

[more about: doctype] [^top^]

<encrypt $data $key>

encrypt returns each value of $data, encrypted Unix style, using key $key.

See also: decrypt, pwencrypt

[more about: encrypt] [^top^]

<ENTRYFUNC = function>
<EXITFUNC = function>

Directive: additional function to call first at entry ( ENTRYFUNC) before the start function, and last at exit ( EXITFUNC) after execution ends normally (without exit). Module entry and exit functions are called (in undefined order) before main script entry and exit functions.

See also: EntryScript (vhttpd URL Settings), ExitScript (vhttpd URL Settings)

[more about: ENTRYFUNC, EXITFUNC] [^top^]

<EXEC [options] program [arg ...][ /]>
  ... input to program ...
[</EXEC>]

Executes program with given args. Output of enclosed block becomes input to program.

EXEC returns the standard output of the program (unless BKGND or TOFILE is given). If the NOBR or BIN flags are given, the output is one value; otherwise the output is split into one value per line.

See also: CAPTURE

[more about: EXEC] [^top^]

<exit [$code]>

exit terminates the script immediately. The optional integer $code becomes the exit code of the Vortex process (default 0).

exit returns nothing.

See also: RETURN

[more about: exit] [^top^]

<EXPORT $var [$var ...] [flags]>

Marks variables to be saved and restored at next script invocation, i.e. session variables.

[more about: EXPORT] [^top^]

<fetch [METHOD=$methods] $theurl [$rawdoc]>

<fetch PARALLEL[=n] [METHOD=$methods] [URLS=]$urls [$loopvar ...]>
  ...
</fetch>

Parallel version: all $urls are retrieved, up to n (default 10) at a time, using parallel protocol method(s) listed in $methods (default "GET"). Completed URLs are returned, fastest first, one per loop iteration. Use <urlinfo> for information about current URL in loop. $loop and $next incremented each iteration.

fetch returns the raw document just fetched (after content/transfer encodings decoded), or the value of $rawdoc.

See also: submit, urlinfo, urlcp

[more about: fetch] [^top^]

<flush>

The flush function flushes any pending (printed but not sent) output to the server (and thus indirectly back to the web client).

flush returns nothing.

See also: fmtcp, mm, rex

[more about: flush] [^top^]

<fmt format [arg ...]>

<strfmt format [arg ...]>

Prints arguments formatted, to output or string.

Format codes:

Format flags:

Metamorph hit markup sub-flags (after m):

Date/time format codes; note that these may vary by OS:

Subformat codes for %L (latitude/longitude/location). For %D/%M/%S codes, width, precision, space, zero, minus flags can be given, and d, i, f, g flags print according to that standard code:

Format escape codes:

fmt returns nothing. strfmt returns the formatted output as a string in $ret.

[more about: fmt, strfmt] [^top^]

<fmtcp $setting [args ...]>

fmtcp controls various facets of fmt and variable printing behavior. The possible settings are:

fmtcp has no effect on $ret.

See also: fmt, strfmt, mm, sb, rex, split

[more about: fmtcp] [^top^]

<fmtinfo $value>

fmtinfo obtains the current values for various facets of fmt and variable printing behavior. The possible values are:

fmtinfo returns a value according to its arguments.

[more about: fmtinfo] [^top^]

<geo2code $lat $lon [$radius]>

geo2code returns a long integer for each latitude/longitude coordinate pair given, for a BETWEEN(aaa, bbb) GIS search. If a $radius argument is given, geo2code returns a comma-separated parenthetical pair of numbers instead, for the bounding box that contains a circle of that radius centered on the point. All arguments are Texis/Vortex DDDMMSS integers (DMS "degrees minutes seconds" format, west-positive).

See also: <code2geo> Vortex function, latlon2geocode(), latlong2geocodearea() SQL functions

[more about: geo2code] [^top^]

<getpid>

The getpid function returns the integer Vortex process ID.

See also: sysinfo, procexists, kill

[more about: getpid] [^top^]

<getvar [NOMSG] $var>

The getvar function returns the values of the (single) named variable.

See also: setvar, readvars, varinfo

[more about: getvar] [^top^]

<hash [options ...] [DATA=]$buf[ /]>

<hash [options ...]> ... </hash>

Options:

Hash TYPEs:

Microsoft CryptoAPI algorithm TYPEs:

OUTPUT and RET values:

PROVTYPEs:

PROVIDER values:

The hash function returns a hash or checksum value for each value of DATA=$buf (or the output of the enclosed block). The return type varies with options but defaults to counter.

See also: fetch, urlinfo

[more about: hash] [^top^]

<header NAME=$name [VALUE=$value] [options]>

<header COOKIE=$name [VALUE=$value] [options] [cookie-options]>

PRINTIF valid for both NAME and COOKIE. All other options are COOKIE only:

PRINTIF / SECUREIF condition flags:

header returns nothing.

See also: URL syntax, EXPORT, RFC 2109 (cookie specification)

[more about: header] [^top^]

<IF condition1>
  ... statements if condition1 true ...
[<ELSEIF condition2>
  ... statements if condition2 true ...]
[<ELSE>
  ... statements if both are false ...]
</IF>

Condition may be simple: arg1 op arg2 where op is one of:

Or condition may be a SQL WHERE clause.

See also: SWITCH

[more about: IF, ELSE, ELSEIF] [^top^]

<kill $pid [$sig]>

To each process id in $pid, the kill function sends the signal in the corresponding value of $sig. If fewer values of $sig are present than $pid, the last is re-used; if none are given, SIGTERM (15) is used. Signals may be given as numbers or names (e.g. "SIGHUP" and 1 are generally equivalent).

The kill function returns 1 if the call succeeds, 0 if not. In version 3.01.983500000 20010301 and earlier, nothing is returned.

See also: getpid, procexists

[more about: kill] [^top^]

<loadavg>

loadavg returns a list of 3 double values representing the system load averages. In the event of an error, -1 is returned for one or more of the values.

See also: sysinfo

[more about: loadavg] [^top^]

<LOCAL var[=value|$initValue] ...]>
  ...
[</LOCAL>]

Defines and declares given variables to be local. Scope ends at matching </LOCAL> tag, or end of enclosing block if not given.

See also: Function definitions, Variable scope discussion

[more about: LOCAL] [^top^]

<loguser $REMOTE_ADDR [$limit]>

loguser returns "Success", or "Fail" if more than $limit (default 5) distinct users have accessed the server in the past minute (as counted by loguser). The count for the given user is updated in either case.

See also: userstats, resetstats

[more about: loguser] [^top^]

<LOOP [SKIP=s] [MAX=m] [REV] $var1 ...>
  ... statements ...
</LOOP>

Iterates over named variables, one value per loop iteration.

$loop and $next are set at start of each iteration and at loop end:

See also: SQL, BREAK

[more about: LOOP] [^top^]

<lower $str [$mode]>

lower returns its $str parameter with all values converted to lower case characters. $mode is an optional stringcomparemode value.

See also: upper, strfold

[more about: lower] [^top^]

varstrlst mailParseAliases(varchar aliases, varchar what
                           [, varchar flags])

Parameters:

• aliases - A varchar string in sendmail /etc/aliases format

• what - A varchar field indicating what to return:

  • "aliases" - List of entries' aliases (left side)

  • "targets" - List of entries' targets (right side)

  • "types" - List of entries' types: "include", "fail", "pipe", "file", "address"

• flags - An optional CSV list of flags:

  • "includes" - Parse include files (default)

  • "noincludes" - Do not parse include files

Returns:

• A varstrlst list of aliases, targets or types

[more about: mailParseAliases] [^top^]

<mm> ... $variables ... </mm>

Enables/disables automatic hit markup of printed variables, previously configured with fmtcp.

<mm> and </mm> have no effect on $ret.

See also: fmtcp, fmt, strfmt, sb

[more about: mm] [^top^]

<nsinfo $name [$which]>

Error codes and messages:

nsinfo returns the requested information from the last nslookup completed.

See also: urlcp, nslookup

[more about: nsinfo] [^top^]

<nslookup [options] $host|$ip[ /]>

<nslookup PARALLEL[=n] [opts] [HOSTS|ADDRS=]$hosts|$ips [$loopvar ...]>
  ...
</nslookup>

nslookup returns the resolved IP address or domain name, as appropriate. On error, either the original value or an empty string is returned, depending on the MTERR flag.

See also: urlcp, nsinfo, fetch

[more about: nslookup] [^top^]

<options $values $selected $output
         [$classes [$ids [$titles]]]>

Prints HTML <option> for each $output value; $values are the corresponding values. $values matching any of the $selected values are pre-selected. $classes gives CSS classes to assign, $id gives id attributes, $titles gives titles (i.e. hover text).

options returns nothing.

See also: radiobutton, checkbox

[more about: options] [^top^]

<pagelinks [options]>

pagelinks returns 0.

See also: SQL and its special variables, especially $rows.min and $rows.max

[more about: pagelinks] [^top^]

<pdfxml $query $Body [options ...]>

Prints XML for Adobe browser plugin to highlight terms while displaying a PDF. Options:

The pdfxml function returns a list of strings to be sent to the Web browser's PDF viewer plugin.

[more about: pdfxml] [^top^]

<!-- pragma [push|pop] name [value] -->

Inline compiler directive; takes effect after location in code.

See also: urlcp

[more about: pragma] [^top^]

<procexists $pid>

The procexists function returns 1 if the process exists, or 0 if not, for each $pid.

See also: sysinfo, getpid, kill

[more about: procexists] [^top^]

<profiler INIT $table [$profile [$field [$db]]]>
<profiler GET $msg [$profile]>

Example usage:

  ... create table SearchTable with queries and index ...
  <profiler INIT SearchTable testProfile QueryField>
  ... get new message $msg ...
  <profiler GET $msg testProfile>        <!-- trim the $msg -->
  <SQL "select Name from SearchTable where QueryField likein $ret">
     $Name matches the message
  </SQL>

The profiler INIT command returns "Ok" on success, otherwise a human-readable error message. The profiler GET command returns the intersection of the words in msg with those in the index.

See also: xtree, wordlist

[more about: profiler] [^top^]

<PUTMSG call|log|print|all|override on|off|exceptiononly>

Directive: whether to log, print, and/or call <putmsg> on errors. <vxcp putmsg> usually overrides this. Default is log and print on, unless a <putmsg> function is defined, in which case default is call on and log / print exceptiononly. override and call are on / off only.

See also: vxcp, Error Messages section (Vortex Error Messages), ErrorScript ErrorFile settings in texis.ini (Vortex texis.ini Configuration Settings)

[more about: PUTMSG] [^top^]

<pwencrypt $pass $salt>

pwencrypt returns each $pass password, encrypted Unix-style. A random salt is used if $salt is empty.

See also: encrypt, decrypt

[more about: pwencrypt] [^top^]

<radiobutton $name $values $selected $output
             [$classes [$ids [$titles]]]>

Prints HTML radiobutton for each $output value. $name is the name for the radiobuttons, $values are the values. $values matching any of the $selected values are pre-checked. $classes gives CSS classes to assign, $id gives id attributes, $titles gives titles (i.e. hover text).

radiobutton returns nothing.

See also: options, checkbox

[more about: radiobutton] [^top^]

<rand $min $max>

rand returns a pseudo-random integer n, $min <= n < $max.

See also: randpick, srand

[more about: rand] [^top^]

<randpick $var>

The randpick function returns a single randomly-selected value of $var, as a string.

See also: rand, srand

[more about: randpick] [^top^]

<read $files [$offset [$length]]>

read returns a list of the contents of each file, from the indicated offset and length. Empty value(s) indicate an error reading the file or the file was empty.

See also: READLN, spew, fetch, submit

[more about: read] [^top^]

<READLN [options] $file[ /]>
  ... statements ...
[</READLN>]

Reads text one line at a time from $file, looping over each.

READLN returns a list of the lines read from the file (without newlines), or the last line read if ROW is set.

See also: read, spew, WRITE

[more about: READLN] [^top^]

<readvars $srcvarnames [$destvarnames] $urldata>

The readvars function returns the number of values that were URL-decoded and assigned from $urldata. $srcvarnames is the list of valid $urldata variable names; $destvarnames is the optional list of Vortex variables to assign to.

See also: fmt "%U", fmt "%!U", getvar, setvar

[more about: readvars] [^top^]

<resetstats $REMOTE_ADDR>

The resetstats function resets the user access count - maintained by loguser - for the given user to 0. If the $REMOTE_ADDR argument is empty, all users are reset.

resetstats returns nothing.

See also: loguser, userstats

[more about: resetstats] [^top^]

<RETURN [$value]>

End current function.

RETURN sets a return value if an argument is given.

See also: BREAK, exit

[more about: RETURN] [^top^]

<rex $expr $data[ /]>                <split $expr $data[ /]>
  or                                   or
<rex [options] $expr $data>          <split [options] $expr $data>
  ...                                  ...
</rex>                               </split>

Specifying any option makes the statement looping. Options:

rex returns a list of the matching hits from $data. split returns a list of the non-matching data. If looping, the corresponding byte offset into the current search item is returned in $ret.off as well.

[more about: rex, split] [^top^]

<rmcommon $data $template [$maxrm]>

The rmcommon function removes the prefix and suffix text from each $data value that is shared with the corresponding $template value. Up to $maxrm characters are removed, rounded down to the nearest word boundary; the default is the maximum amount of common text. This function is useful in stripping common header and footer text from web pages before indexing.

rmcommon returns $data with its common prefix/suffix text removed.

[more about: rmcommon] [^top^]

<sandr $expr $replace $data>

Special replacement string characters:

sandr returns the $data list with any replacements made.

[more about: sandr] [^top^]

<sb> ... $variables ... </sb>

Enables/disables automatic search-and-blast (sandblast) or search-and-call (sandcall) markup of printed variables, previously configured with fmtcp.

<sb> and </sb> have no effect on $ret.

See also: fmtcp, fmt strfmt, mm

[more about: sb] [^top^]

<SCHEDULE [options] WHEN=schedule [--] [var=val] [...]>

Schedule script for periodic execution according to schedule, which is a vCalendar schedule or one of the following:

minutes
[EVERY] [n] DAY[S]|DAILY timeofday [minutes]
[EVERY] [n] WEEK[S|LY] [ON] weekday timeofday [minutes]
[EVERY] [n] MONTH[S|LY] [ON] [THE] FIRST|SECOND|THIRD|FOURTH|n [TO LAST]
     weekday|DAY [OF THE MONTH] timeofday [minutes]

where:

minutes = [EVERY] [n] MIN[UTE[S]] [[REPEAT] n [TIME[S]]
timeofday = AT [h]h[:][[m]m] [A|P[M]]
weekday = SUN|MON|TUE|WED|THU|FRI|SAT

See also: Vortex Scheduling

[more about: SCHEDULE] [^top^]

<send $values>

send prints each of the $values out as-is, without the HTML escapement normally done with variables.

send returns nothing.

See also: spew, VERB

[more about: send] [^top^]

<setvar [flags] $var $values>

The setvar function sets the single variable named by $var to $values, and returns nothing.

See also: getvar, readvars

[more about: setvar] [^top^]

<sleep $seconds [wake]>

sleep returns the number of seconds remaining to be slept (a float), which is normally 0. However, if the "wake" argument is given, sleep may wake up early and return a non-zero value, if a signal was caught. (This can be used to wait for another process to signal the script and wake it up.)

[more about: sleep] [^top^]

<slist $intersect $values>

slist returns a Metamorph query for $intersect intersections of the values of $values.

See also: clist, Metamorph documentation

[more about: slist] [^top^]

<sort [flags] $var [ICASE|NUM] [DESC|ASC] [$var2 ...]>

Flags that may appear first, before any variables:

sort returns the sorted list in $ret if one variable is given; otherwise it returns nothing and the variables are sorted in place.

See also: uniq

[more about: sort] [^top^]

<spew $files [$offset [$length]]>

The spew function reads each file given in $files and prints it out verbatim. If "-" (single dash) is given, the standard input is sent.

spew returns 1 for each value of $files if successful, or an empty string if not.

See also: send, read, fetch

[more about: spew] [^top^]

<SQL [options] "SQL command" ["SQL fragment" ...][ /]>
  ... Vortex statements ...
[</SQL>]

Executes SQL command, looping for each row returned. Multiple arguments concatenated to produce SQL command. Returned columns become Vortex variables, one value per loop.

Special variables set by <SQL>. All are set at the start of each iteration, and at normal loop end, unless otherwise noted:

[more about: SQL] [^top^]

<SQLCACHE = n>

Directive: number of Texis handles to cache for SQL statements. Default is 2.

See also: SQL, sqlcp

[more about: SQLCACHE] [^top^]

<sqlcp $name $value [...]>

Controls various low-level SQL parameters or actions not settable with apicp.

sqlcp returns a setting-specific value.

See also: apicp, SQLCACHE

[more about: sqlcp] [^top^]

<srand $seed>

Seeds the pseudo-random number generator used by rand. An empty string for $seed will cause a semi-random seed to be used.

The srand function returns the previous seed value.

See also: rand, randpick

[more about: srand] [^top^]

<STACK=n>

Directive: sets Vortex call stack limit (-1 for no limit). Default is 250. One stack level used per function, block or loop call.

See also: vxcp

[more about: STACK] [^top^]

<stat [options] $path[ /]> [</stat>]

Obtains information about file(s). Options:

Returned variables:

stat returns the file path in $ret, plus various other $ret.... variables as listed above. If the looping syntax is used (a closing </stat> tag), $loop and $next are set as well as the other variables.

See also: sysutil, read, WRITE

[more about: stat] [^top^]

<strcmp $a $b [$mode]>
<strcmpi $a $b [$mode]>

The strcmp function compares every value of $a against every value of $b as a string. For each comparison, an integer value is returned:

• < 0 if $a < $b

• 0 if $a = $b

• > 0 if $a > $b