====== getUserState ======
{#JAPI Joomla.Framework Application JApplication::getUserState #}

Gets the value of the user state variable. User state variables are stored with the session and are persistent between requests.

===== Syntax =====
mixed getUserState ( **$key** )

| **$key** | string | is a string containing the path of the state. |

===== Examples =====
If the following code was executed on a previous page load:
<code php|Example>
global $mainframe;

$mainframe->setUserState( "$option.sampleState", "Stored value" );
</code>
then the following code:
<code php|Example>
global $mainframe;

echo $mainframe->getUserState( "$option.sampleState" );
</code>
will produce
<code php|Result>
Stored value
</code>

----

~~DISCUSSION~~