RolePrincipal.IsRoleListCached Property
Assembly: System.Web (in system.web.dll)
'Declaration Public ReadOnly Property IsRoleListCached As Boolean 'Usage Dim instance As RolePrincipal Dim value As Boolean value = instance.IsRoleListCached
/** @property */ public boolean get_IsRoleListCached ()
public function get IsRoleListCached () : boolean
Not applicable.
Property Value
true if role names are cached in a cookie; otherwise, false.If the cacheRolesInCookie attribute in the Web.config file for the application is set to true, then a list of role names for the current user is written to a cookie when user membership in a particular role is checked. The IsRoleListCached property indicates whether role names have been written to the cookie. Note that, even though the cacheRolesInCookie configuration attribute may be true, the IsRoleListCached property does not return true until after role information has been written to the cookie. If no role checks are performed for a user, IsRoleListCached will return false.
The following example displays role-caching information for the current user if role management is enabled. For information on enabling role management, see the Roles class.
<%@ Page Language="VB" %> <%@ Import Namespace="System.Web.Security" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Public Sub Page_Load() Try Dim r As RolePrincipal = CType(User, RolePrincipal) IsCachedLabel.Text = r.IsRoleListCached.ToString() CacheChangedLabel.Text = r.CachedListChanged.ToString() ExpiredLabel.Text = r.Expired.ToString() VersionLabel.Text = r.Version.ToString() IssueDateLabel.Text = r.IssueDate.ToString() ExpireDateLabel.Text = r.ExpireDate.ToString() CookiePathLabel.Text = r.CookiePath Msg.Text = "" Catch e As InvalidCastException Msg.Text = "User is not of type RolePrincipal. Are roles enabled?" End Try End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head> <title>Role Information</title> </head> <body> <form id="form1" runat="server"> Role Information for <b><%=User.Identity.Name%></b>.<br /> <asp:Label id="Msg" runat="Server" ForeColor="maroon" /><br /> <table border="1" cellpadding="4" cellspacing="4"> <tr> <td>IsRoleListCached</td> <td><asp:Label id="IsCachedLabel" runat="Server" /></td> </tr> <tr> <td>CachedListChanged</td> <td><asp:Label id="CacheChangedLabel" runat="Server" /></td> </tr> <tr> <td>Expired</td> <td><asp:Label id="ExpiredLabel" runat="Server" /></td> </tr> <tr> <td>Version</td> <td><asp:Label id="VersionLabel" runat="Server" /></td> </tr> <tr> <td>IssueDate</td> <td><asp:Label id="IssueDateLabel" runat="Server" /></td> </tr> <tr> <td>ExpireDate</td> <td><asp:Label id="ExpireDateLabel" runat="Server" /></td> </tr> <tr> <td>CookiePath</td> <td><asp:Label id="CookiePathLabel" runat="Server" /></td> </tr> </table> </form> </body> </html>