View / Download this file.
-------------------------
session_delete() FUNCTION
-------------------------
------------
USAGE FORMAT
------------
Within a PREPROCESS tag:
&session_delete($name);
-----------
DESCRIPTION
-----------
The session_delete() function removes a cookie value from the current PTM
Session. May be used ONLY in a PREPROCESS tag.
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 not take effect.
---------
ARGUMENTS
---------
$name
REQUIRED
The name of the cookie you with to delete. Behind the scenes this name
will be prefixed with 'PTMSESSION' before being sent to the user, and that
same string will be parsed off before any returns to you are made.
-------
RETURNS
-------
NONE
--------------
USAGE EXAMPLES
--------------
---------------------------------------------------------------------------
Example 1: Removing a "Color" Cookie from the Session, If the Cookie Exists
---------------------------------------------------------------------------
<?:
if (defined $_SESSION{'Color'}) {
&session_delete('Color');
&update_session();
}
?>
--------
SEE ALSO
--------
TAGS
PREPROCESS
VARIABLES
%_COOKIES, %_SESSION, %_SET_COOKIES
FUNCTIONS
delete_cookie(), end_session(), is_session(), session_add(),
session_domain(), session_id(), session_name(), session_path(),
session_secure(), set_cookie(), start_session(), update_session()
|