Thunderstone Software Document Search, Retrieval, and Management
Search:
Vortex Manual
 

A - function definition

 

SYNOPSIS

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


DESCRIPTION
An anchor (<A>) tag delimits Vortex script functions. The function name is given by the NAME attribute. Following the anchor tag are the function's statements, and a closing </A> tag ends the function.

Function names, like variable names, are composed solely of alphanumeric characters, underscores (_), periods or spaces (i.e. if the name is in quotes), optionally starting with a slash (/). There must be at least one letter or underscore, which must occur before any digits. A function name cannot be a reserved word, such as an HTML or Vortex tag, or the name of a previously-declared function (such as a builtin or user function). These are the reserved tag names in Vortex:

ADDTRAILING DEFAULT FMTINFO PAGELINKS SORT TRACESQL
ARRAY ELSE GETVAR PASS SPLIT TRAP
BREAK ELSEIF HASH PUTMSG SQL UNIQ
CAL ENTRYFUNC HEADER READLN SQLCACHE USER
CALDATE EXEC IF READMAILMSG STACK USES
CALRULE EXIT LOCAL READVARS STAT VARINFO
CAPTURE EXITFUNC LOOP RETURN STRFMT VXCP
CASE EXPORT MAILINFO REX SUBMIT WHILE
CONTINUE FETCH MAILUTIL SB SWITCH WRITE
COOKIES FMT MM SCHEDULE TIMEOUT XTREE
DB FMTCP NSLOOKUP SETVAR TIMPORT

Script function names are case-sensitive. A function name may start with a slash (/), so that end-tag like functions can be declared. Function declarations cannot be nested ala Pascal; any anchor tags inside a function are printed out like any other non-Vortex tag. However, unlike some languages, Vortex functions can be called before the point they are declared (i.e. no C-like prototypes are needed).



Copyright © Thunderstone Software     Last updated: Mon Feb 18 10:28:15 EST 2013
 
Home   ::   Products   ::   Solutions   ::   How to Buy   ::   Support   ::   Contact Us   ::   News   ::   About
Copyright © 2013 Thunderstone Software LLC. All rights reserved.