Tcl API Functions for ADPs

The following Tcl functions are available for use within ADPs. They are described in detail on the specified pages.

Tcl Function	Brief Description
ns_adp_abort (see page 45)	Aborts processing of the ADP file and throws away any output up to that point.
ns_adp_argc (see page 46)	Returns the number of arguments passed to the ADP.
ns_adp_argv (see page 47)	Returns the values of the arguments passed to the ADP.
ns_adp_bind_args (see page 48)	Copies arguments from the current ADP frame into local variables.
ns_adp_break (see page 49)	Aborts processing of the ADP file and flushes all output (from ns_puts or static HTML) up to the point where it was called. Nothing is output or executed after it is called.
ns_adp_debug (see page 50)	Connects to TclPro debugger.
ns_adp_dir (see page 51)	Returns the directory in which the ADP resides.
ns_adp_dump (see page 52)	Returns text of ADP output buffer.
ns_adp_eval (see page 53)	Evaluates an ADP and sends its output as the result.
ns_adp_exception (see page 54)	Returns the current ADP exception state.
ns_adp_include (see page 55)	Writes the contents of the specified file to the page as if it were the argument to ns_puts. The ADP file is parsed before it is inserted into the page.
ns_adp_parse (see page 56)	Processes the specified ADP file and returns the result as a string.
ns_adp_puts (see page 57)	Writes a string or Tcl command output to the page.
ns_adp_registertag (see page 58)	Registers an ADP tag that you define.
ns_adp_return (see page 59)	Stop processing of an ADP and flush all output
ns_adp_stream (see page 60)	Begins streaming mode to send all ADP output to the conn.
ns_adp_tell (see page 61)	Returns the number of bytes in the ADP output buffer.
ns_adp_trunc (see page 62)	Clears the ADP output buffer.
ns_register_adptag (see page 160)	Registers an ADP tag that you define.