pnSessionSetVar

set session variable

Synopsis

bool pnSessionSetVar(name, value);

Description

pnSessionSetVar() sets a session-specific variable on the PostNuke system. If the variable does not exist then it is created.

Parameters

name

The name of the session variable to set

value

The value to set the session variable with

Return Values

This function returns true if the variable was set, and void if there was an internal API error whilst attempting to set the variable.

Notes

Session variables are not guaranteed to exist from one process run to the next. Internal housekeeping might remove sessions that have been inactive for long periods of time, so do not use session variables to store long-term information.

See Also

pnSessionGetVar(), pnSessionDelVar()