------------------------------
set_redirect_header() FUNCTION
------------------------------

  ------------
  USAGE FORMAT
  ------------

    Within a PREPROCESS tag:

    &set_redirect_header($url)
    &set_redirect_header($url, $delay)

  -----------
  DESCRIPTION
  -----------

    A direct implementation of the redirect_header() function on the $_HEADER
    value. Sets the $_HEADER value to a fully qualified redirecting refresh HTTP
    header, with an optional delay (in seconds), complete with double new line
    character (\n) termination. Note that the entire page will be loaded before
    redirection occurs, so care should be taken to prevent page loading when
    ONLY a redirect is reqired without showing page contents. May be used ONLY
    in a PREPROCESS tag.

  ---------
  ARGUMENTS
  ---------

    $url

      REQUIRED

      The full URL to which you wish to redirect the user.

    $delay

      OPTIONAL
      
      The number of seconds you wish to delay on the page before redirecting.
      This most often gives the user a chance to read a redirection message
      before the redirection occurs. If no delay time is given, no delay is
      assumed.

  -------
  RETURNS
  -------

    NONE

  --------------
  USAGE EXAMPLES
  --------------

    --------------------------------------------------------------------------
    Example 1: Redirecting to Another Page After 5 Seconds in a PREPROCESS Tag
    --------------------------------------------------------------------------

      <?: &set_redirect_header('http://www.mysite.com/page2.ptm', 5); ?>

  --------
  SEE ALSO
  --------

    TAGS

      PREPROCESS

    VARIABLES

      $_HEADER

    FUNCTIONS

      basic_header(), redirect_header(), set_basic_header()