-----------------------
session_path() FUNCTION
-----------------------

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

    Setting:

      Within a PREPROCESS tag:

      &session_path($path);

    Retreiving:

      Where $path is a session path buffer:

      $path = &session_path();

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

    The session_path() function is used to either set or retrieve the value of
    $_SESSION{'PATH'}. When an argument is provided, the value is set. If no
    argument is provided the value is simply returned. To clear the value of
    $_SESSION{'PATH'}, the session_delete() function may be used to remove the
    value from the %_SESSION hash all together or session_add() can be used to
    set it to an empty value. Alternately, the hash value can be set manually.

    The path argument must qualify as a valid cookie path, meaning that it must
    begin and end with a forward slash (/) and must represent a valid relative
    path from your root web accessible directory on your host server -- e.g. '/'
    or '/mypath/'.

    When using this function to set values for the PTM Session, it may be used
    ONLY in a PREPROCESS tag to have any effect on the "Set-Cookie:" HTTP
    headers. After any modifications have been made using this function, a call
    to update_session() or start_session() MUST be made before ending the
    PREPROCESS tag, otherwise changes will have no effect.

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

    $path

      REQUIRED TO SET

      A cookie-qualifying path value that begins and ends with a forward slash
      (/) and represents a valid relative path from your root web accessible
      directory on your host server.

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

    The PTM Session path from $_SESSION{'PATH'}.

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

    ---------------------------------------
    Example 1: Setting the PTM Session Path
    ---------------------------------------

      <?:
        &session_path('/mypath/');
        &update_session();
      ?>

    ------------------------------------------------------
    Example 2: Displaying the PTM Session Path to the User
    ------------------------------------------------------

      This PTM Session's Path value is <?= &session_path() ?>

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

    TAGS

      PREPROCESS, DISPLAY

    VARIABLES

      %_COOKIES, %_SESSION, %_SET_COOKIES

    FUNCTIONS

      delete_cookie(), end_session(), is_session(), session_add(),
      session_delete(), session_domain(), session_id(), session_name(),
      session_secure(), set_cookie(), start_session(), update_session()