ns_register_adptag

Overview

Register a tag for use within an ADP

Syntax

ns_register_adptag command endcommand proc

Description

ns_register_adptag registers a procedure to be called when the specified beginning and ending tags are used in an ADP. The command is the beginning tag to look for, and the endcommand is the ending tag to look for. The proc is the procedure that will be called when AOLserver encounters those tags when processing an ADP.

The procedure you specify must be of the form:

    proc myadpproc { string tagset }

The string is the string of characters between the beginning tag and the ending tag. The tagset is an ns_set of parameters that were specified with the beginning tag. The return value of the procedure will be sent to the browser in place of the string of text that was specified between the beginning and ending tags.

Note: This function cannot be called after the server has started. It must be called in a Tcl script in a virtual server's Tcl directory so that it can be initialized at server startup time.

Example

For example, suppose you want to register a tag that displays the enclosed text only if it is Christmas. You could register the tag as follows:

    ns_register_adptag "christmas" "/christmas" xmas
    proc xmas {string tagset} {
      if {[ns_fmttime [ns_time] "%m/%d"] == "12/25"}  then {
      return $string
      }
    }

Then, in an ADP, you could use these tags:

    <christmas>Merry Christmas to all, and to all a good night!
    </christmas>

Top of Page

Copyright © 1996 America Online, Inc.