File: RolePrincipal.xml

package info (click to toggle)
mono-reference-assemblies 3.12.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 604,240 kB
  • ctags: 625,505
  • sloc: cs: 3,967,741; xml: 2,793,081; ansic: 418,042; java: 60,435; sh: 14,833; makefile: 11,576; sql: 7,956; perl: 1,467; cpp: 1,446; yacc: 1,203; python: 598; asm: 422; sed: 16; php: 1
file content (440 lines) | stat: -rw-r--r-- 28,830 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
<?xml version="1.0" encoding="utf-8"?>
<Type Name="RolePrincipal" FullName="System.Web.Security.RolePrincipal">
  <TypeSignature Language="C#" Value="public sealed class RolePrincipal : System.Security.Principal.IPrincipal" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.Security.Principal.IPrincipal</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Web.Security.RolePrincipal" /> object implements the <see cref="T:System.Security.Principal.IPrincipal" /> interface and represents the current security context for the HTTP request.</para>
      <para>When role management is enabled (see <see cref="T:System.Web.Security.Roles" />), the <see cref="T:System.Web.Security.RoleManagerModule" /> assigns a <see cref="T:System.Web.Security.RolePrincipal" /> object to the <see cref="P:System.Web.HttpContext.User" /> property of the <see cref="P:System.Web.HttpContext.Current" /> <see cref="T:System.Web.HttpContext" />.</para>
      <para>The <see cref="T:System.Web.Security.RolePrincipal" /> class exposes the security identity for the current HTTP request and additionally performs checks for role membership. If <see cref="P:System.Web.Security.Roles.CacheRolesInCookie" /> is true, then the <see cref="T:System.Web.Security.RolePrincipal" /> object manages the cached list of roles and looks up role membership for the current user in the cached list first, then the role <see cref="P:System.Web.Security.Roles.Provider" />. If <see cref="P:System.Web.Security.Roles.CacheRolesInCookie" /> is false, the <see cref="T:System.Web.Security.RolePrincipal" /> object always looks up role membership using the role provider.</para>
      <para>The <see cref="T:System.Web.Security.RolePrincipal" /> object encrypts and decrypts role information cached in the cookie identified by the <see cref="P:System.Web.Security.Roles.CookieName" /> based on the <see cref="P:System.Web.Security.Roles.CookieProtectionValue" />.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Represents security information for the current HTTP request, including role membership. This class cannot be inherited.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RolePrincipal (System.Security.Principal.IIdentity identity);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="identity" Type="System.Security.Principal.IIdentity" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This overload of the <see cref="M:System.Web.Security.RolePrincipal.#ctor(System.Security.Principal.IIdentity)" /> constructor creates a new <see cref="T:System.Web.Security.RolePrincipal" /> object and initializes its property values. Cached role information is not read from the cookie identified by the <see cref="P:System.Web.Security.Roles.CookieName" /> property. The <see cref="P:System.Web.Security.RolePrincipal.ProviderName" /> property is set to the <see cref="P:System.Configuration.Provider.ProviderBase.Name" /> of the default role provider.</para>
          <para>For information on enabling role management, see the <see cref="T:System.Web.Security.Roles" /> class.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Instantiates a <see cref="T:System.Web.Security.RolePrincipal" /> object for the specified <paramref name="identity" />.</para>
        </summary>
        <param name="identity">
          <attribution license="cc4" from="Microsoft" modified="false" />The user identity to create the <see cref="T:System.Web.Security.RolePrincipal" /> for.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RolePrincipal (System.Security.Principal.IIdentity identity, string encryptedTicket);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="identity" Type="System.Security.Principal.IIdentity" />
        <Parameter Name="encryptedTicket" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This overload of the <see cref="M:System.Web.Security.RolePrincipal.#ctor(System.Security.Principal.IIdentity,System.String)" /> constructor creates a new <see cref="T:System.Web.Security.RolePrincipal" /> object and initializes its property values. Role information for the current user is read from the supplied <paramref name="encryptedTicket" /> and cached with the <see cref="T:System.Web.Security.RolePrincipal" /> object. The <see cref="P:System.Web.Security.RolePrincipal.ProviderName" /> property is set to the <see cref="P:System.Configuration.Provider.ProviderBase.Name" /> of the default role provider.</para>
          <para>For information on enabling role management, see the <see cref="T:System.Web.Security.Roles" /> class.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Instantiates a <see cref="T:System.Web.Security.RolePrincipal" /> object for the specified <paramref name="identity" /> with role information from the specified <paramref name="encryptedTicket" />.</para>
        </summary>
        <param name="identity">
          <attribution license="cc4" from="Microsoft" modified="false" />The user identity to create the <see cref="T:System.Web.Security.RolePrincipal" /> for.</param>
        <param name="encryptedTicket">
          <attribution license="cc4" from="Microsoft" modified="false" />A string that contains encrypted role information.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RolePrincipal (string providerName, System.Security.Principal.IIdentity identity);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="providerName" Type="System.String" />
        <Parameter Name="identity" Type="System.Security.Principal.IIdentity" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This overload of the <see cref="M:System.Web.Security.RolePrincipal.#ctor(System.String,System.Security.Principal.IIdentity)" /> constructor creates a new <see cref="T:System.Web.Security.RolePrincipal" /> object and initializes its property values. The <see cref="P:System.Web.Security.RolePrincipal.ProviderName" /> property is set to the value specified in the <paramref name="providerName" /> parameter.</para>
          <para>For information on enabling role management, see the <see cref="T:System.Web.Security.Roles" /> class.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Instantiates a <see cref="T:System.Web.Security.RolePrincipal" /> object for the specified <paramref name="identity" /> using the specified <paramref name="providerName" />.</para>
        </summary>
        <param name="providerName">
          <attribution license="cc4" from="Microsoft" modified="false" />The name of the role provider for the user.</param>
        <param name="identity">
          <attribution license="cc4" from="Microsoft" modified="false" />The user identity to create the <see cref="T:System.Web.Security.RolePrincipal" /> for.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RolePrincipal (string providerName, System.Security.Principal.IIdentity identity, string encryptedTicket);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="providerName" Type="System.String" />
        <Parameter Name="identity" Type="System.Security.Principal.IIdentity" />
        <Parameter Name="encryptedTicket" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This overload of the <see cref="M:System.Web.Security.RolePrincipal.#ctor(System.Security.Principal.IIdentity,System.String)" /> constructor creates a new <see cref="T:System.Web.Security.RolePrincipal" /> object and initializes its property values. Role information for the current user is read from the supplied <paramref name="encryptedTicket" /> and cached with the <see cref="T:System.Web.Security.RolePrincipal" /> object. The <see cref="P:System.Web.Security.RolePrincipal.ProviderName" /> property is set to the value specified in the <paramref name="providerName" /> parameter.</para>
          <para>For information on enabling role management, see the <see cref="T:System.Web.Security.Roles" /> class.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Instantiates a <see cref="T:System.Web.Security.RolePrincipal" /> object for the specified <paramref name="identity" /> using the specified <paramref name="providerName" /> and role information from the specified <paramref name="encryptedTicket" />.</para>
        </summary>
        <param name="providerName">
          <attribution license="cc4" from="Microsoft" modified="false" />The name of the role provider for the user.</param>
        <param name="identity">
          <attribution license="cc4" from="Microsoft" modified="false" />The user identity to create the <see cref="T:System.Web.Security.RolePrincipal" /> for.</param>
        <param name="encryptedTicket">
          <attribution license="cc4" from="Microsoft" modified="false" />A string that contains encrypted role information.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="CachedListChanged">
      <MemberSignature Language="C#" Value="public bool CachedListChanged { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.Security.RolePrincipal.CachedListChanged" /> property will return true after role names have been retrieved from the default role <see cref="P:System.Web.Security.Roles.Provider" /> and added to the cache by the <see cref="M:System.Web.Security.RolePrincipal.GetRoles" /> method, or when the <see cref="M:System.Web.Security.RolePrincipal.IsInRole(System.String)" /> method calls the <see cref="M:System.Web.Security.RoleProvider.IsUserInRole(System.String,System.String)" /> method of the default role provider and then receives a response of true, resulting in the role name passed to the <see cref="M:System.Web.Security.RolePrincipal.IsInRole(System.String)" /> method being added to the cache.</para>
          <para>The <see cref="P:System.Web.Security.RolePrincipal.CachedListChanged" /> property will also return true if <see cref="P:System.Web.Security.Roles.CookieSlidingExpiration" /> is set to true and the <see cref="P:System.Web.Security.RolePrincipal.ExpireDate" /> has passed, resulting in a new <see cref="P:System.Web.Security.RolePrincipal.ExpireDate" /> being set.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a value indicating whether the list of role names cached with the <see cref="T:System.Web.Security.RolePrincipal" /> object has been modified.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="CookiePath">
      <MemberSignature Language="C#" Value="public string CookiePath { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.Security.RolePrincipal.CookiePath" /> property returns the value of the cookiePath attribute from the Web.config file for your ASP.NET application. For more information on cookie paths, see <see cref="P:System.Web.HttpCookie.Path" />.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the path for the cached role names cookie.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Expired">
      <MemberSignature Language="C#" Value="public bool Expired { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.Security.RolePrincipal.Expired" /> property returns a Boolean value indicating whether the roles cookie has expired based on the <see cref="P:System.Web.Security.RolePrincipal.ExpireDate" /> and the current date and time.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a value indicating whether the roles cookie has expired.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ExpireDate">
      <MemberSignature Language="C#" Value="public DateTime ExpireDate { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.DateTime</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the date and time when the roles cookie will expire.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="GetRoles">
      <MemberSignature Language="C#" Value="public string[] GetRoles ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String[]</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>If <see cref="P:System.Web.Security.Roles.CacheRolesInCookie" /> is true and role names have been cached for the user represented by the <see cref="T:System.Web.Security.RolePrincipal" />, then the <see cref="M:System.Web.Security.RolePrincipal.GetRoles" /> method will return the list of role names in the cache that the user is a member of. If role names have not been cached, then the <see cref="M:System.Web.Security.RolePrincipal.GetRoles" /> method returns the list of role names that the user is a member of from the default role <see cref="P:System.Web.Security.Roles.Provider" />. Only role names for the current <see cref="P:System.Web.Security.Roles.ApplicationName" /> are returned. To determine whether role names have been cached in the <see cref="T:System.Web.Security.RolePrincipal" /> object, check the <see cref="P:System.Web.Security.RolePrincipal.IsRoleListCached" /> property.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a list of roles that the <see cref="T:System.Web.Security.RolePrincipal" /> is a member of.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The list of roles that the <see cref="T:System.Web.Security.RolePrincipal" /> is a member of.</para>
        </returns>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Identity">
      <MemberSignature Language="C#" Value="public System.Security.Principal.IIdentity Identity { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Security.Principal.IIdentity</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.Security.RolePrincipal.Identity" /> of a <see cref="T:System.Web.Security.RolePrincipal" /> object is set when the <see cref="T:System.Web.Security.RolePrincipal" /> constructor is called.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the security identity for the current HTTP request.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="IsInRole">
      <MemberSignature Language="C#" Value="public bool IsInRole (string role);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="role" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>
            <see cref="M:System.Web.Security.RolePrincipal.IsInRole(System.String)" /> first checks the <see cref="P:System.Web.Security.RolePrincipal.IsRoleListCached" /> property to determine whether a cached list of role names for the current user is available. If the <see cref="P:System.Web.Security.RolePrincipal.IsRoleListCached" /> property is true, the cached list is checked for the specified role. If the <see cref="M:System.Web.Security.RolePrincipal.IsInRole(System.String)" /> method finds the specified role in the cached list, it returns true. </para>
          <para>If <see cref="M:System.Web.Security.RolePrincipal.IsInRole(System.String)" /> does not find the specified role, it calls the <see cref="M:System.Web.Security.RoleProvider.GetRolesForUser(System.String)" /> method of the default <see cref="P:System.Web.Security.Roles.Provider" /> instance to determine whether the user name is associated with a role from the data source for the configured <see cref="P:System.Web.Security.Roles.ApplicationName" /> value.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a value indicating whether the user represented by the <see cref="T:System.Web.Security.RolePrincipal" /> is in the specified role.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>true if user represented by the <see cref="T:System.Web.Security.RolePrincipal" /> is in the specified role; otherwise, false.</para>
        </returns>
        <param name="role">
          <attribution license="cc4" from="Microsoft" modified="false" />The role to search for.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="IsRoleListCached">
      <MemberSignature Language="C#" Value="public bool IsRoleListCached { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>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 <see cref="P:System.Web.Security.RolePrincipal.IsRoleListCached" /> property indicates whether role names have been written to the cookie. Note that, even though the cacheRolesInCookie configuration attribute may be true, the <see cref="P:System.Web.Security.RolePrincipal.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, <see cref="P:System.Web.Security.RolePrincipal.IsRoleListCached" /> will return false.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a value indicating whether the list of roles for the user has been cached in a cookie.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="IssueDate">
      <MemberSignature Language="C#" Value="public DateTime IssueDate { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.DateTime</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the date and time that the roles cookie was issued.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ProviderName">
      <MemberSignature Language="C#" Value="public string ProviderName { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.Security.RolePrincipal.ProviderName" /> property exposes the name of the role provider that manages the role information for the user represented by the <see cref="T:System.Web.Security.RolePrincipal" /> object. This enables you to access the specific role-provider instance for a user by using the <see cref="P:System.Web.Security.Roles.Providers" /> property of the <see cref="T:System.Web.Security.Roles" /> class regardless of whether the provider is the default provider for the application. For example, you may create a method that takes a <see cref="T:System.Web.Security.RolePrincipal" /> as input and returns the list of roles for the represented user. You can ensure that the appropriate role provider is used to return the list of roles for the <see cref="T:System.Web.Security.RolePrincipal" /> by calling the <see cref="M:System.Web.Security.RoleProvider.GetRolesForUser(System.String)" /> method of the role provider from the <see cref="P:System.Web.Security.Roles.Providers" /> collection that is indexed by the <see cref="P:System.Web.Security.RolePrincipal.ProviderName" /> property value.</para>
          <para>To populate the <see cref="T:System.Web.Security.RolePrincipal" /> object for each request, you must use a <see cref="E:System.Web.Security.RoleManagerModule.GetRoles" /> event handler defined in the Global.asax file for the application.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the name of the role provider that stores and retrieves role information for the user.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="SetDirty">
      <MemberSignature Language="C#" Value="public void SetDirty ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.Security.RolePrincipal.SetDirty" /> method marks the cached role list as having been changed by setting <see cref="P:System.Web.Security.RolePrincipal.CachedListChanged" /> to true and <see cref="P:System.Web.Security.RolePrincipal.IsRoleListCached" /> to false.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Marks the cached role list as having been changed.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ToEncryptedTicket">
      <MemberSignature Language="C#" Value="public string ToEncryptedTicket ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The value returned by the <see cref="M:System.Web.Security.RolePrincipal.ToEncryptedTicket" /> method is stored in the roles cookie when <see cref="P:System.Web.Security.Roles.CacheRolesInCookie" /> is true.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns the role information cached with the <see cref="T:System.Web.Security.RolePrincipal" /> object encrypted based on the <see cref="P:System.Web.Security.Roles.CookieProtectionValue" />.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The role information cached with the <see cref="T:System.Web.Security.RolePrincipal" /> object encrypted based on the <see cref="P:System.Web.Security.Roles.CookieProtectionValue" />.</para>
        </returns>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Version">
      <MemberSignature Language="C#" Value="public int Version { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>By including a version number in the roles cookie, future releases of ASP.NET can modify the format of the roles cookie and use the <see cref="P:System.Web.Security.RolePrincipal.Version" /> property to distinguish between different formats.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the version number of the roles cookie.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>