-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
RoleProviderCollection.xml
193 lines (171 loc) · 12.3 KB
/
RoleProviderCollection.xml
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
<Type Name="RoleProviderCollection" FullName="System.Web.Security.RoleProviderCollection">
<TypeSignature Language="C#" Value="public sealed class RoleProviderCollection : System.Configuration.Provider.ProviderCollection" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RoleProviderCollection extends System.Configuration.Provider.ProviderCollection" />
<TypeSignature Language="DocId" Value="T:System.Web.Security.RoleProviderCollection" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class RoleProviderCollection
Inherits ProviderCollection" />
<TypeSignature Language="F#" Value="type RoleProviderCollection = class
 inherit ProviderCollection" />
<TypeSignature Language="C++ CLI" Value="public ref class RoleProviderCollection sealed : System::Configuration::Provider::ProviderCollection" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.Provider.ProviderCollection</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>A collection of objects that inherit the <see cref="T:System.Web.Security.RoleProvider" /> abstract class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The role providers for an application are exposed as a read-only <xref:System.Web.Security.RoleProviderCollection> by the <xref:System.Web.Security.Roles.Providers%2A> property of the <xref:System.Web.Security.Roles> class. You can access a specific role provider in the collection by name and cast it as the specific provider type, such as <xref:System.Web.Security.SqlRoleProvider>. This enables you to manage role information from multiple data stores in a single application as well as access custom members of a role provider that are not part of the <xref:System.Web.Security.RoleProvider> abstract class.
## Examples
The following code example lists the providers enabled for an application and their respective types.
[!code-aspx-csharp[System.Web.Security.Roles#7](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.Roles/CS/Providerscs.aspx#7)]
[!code-aspx-vb[System.Web.Security.Roles#7](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.Roles/VB/Providersvb.aspx#7)]
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/5k850zwb(v=vs.100)">Understanding ASP.NET Role Management</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RoleProviderCollection ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Security.RoleProviderCollection.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 RoleProviderCollection();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Creates a new, empty role-provider collection.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor is not intended to be used from your code.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/5k850zwb(v=vs.100)">Understanding ASP.NET Role Management</related>
</Docs>
</Member>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public override void Add (System.Configuration.Provider.ProviderBase provider);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Add(class System.Configuration.Provider.ProviderBase provider) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Security.RoleProviderCollection.Add(System.Configuration.Provider.ProviderBase)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Add (provider As ProviderBase)" />
<MemberSignature Language="F#" Value="override this.Add : System.Configuration.Provider.ProviderBase -> unit" Usage="roleProviderCollection.Add provider" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Add(System::Configuration::Provider::ProviderBase ^ provider);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="provider" Type="System.Configuration.Provider.ProviderBase" />
</Parameters>
<Docs>
<param name="provider">The role provider to add to the collection.</param>
<summary>Adds a role provider to the collection.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor is not intended to be used from your code.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="provider" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="provider" /> is not of a type that inherits the <see cref="T:System.Web.Security.RoleProvider" /> abstract class.</exception>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/5k850zwb(v=vs.100)">Understanding ASP.NET Role Management</related>
</Docs>
</Member>
<Member MemberName="CopyTo">
<MemberSignature Language="C#" Value="public void CopyTo (System.Web.Security.RoleProvider[] array, int index);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CopyTo(class System.Web.Security.RoleProvider[] array, int32 index) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Security.RoleProviderCollection.CopyTo(System.Web.Security.RoleProvider[],System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub CopyTo (array As RoleProvider(), index As Integer)" />
<MemberSignature Language="F#" Value="override this.CopyTo : System.Web.Security.RoleProvider[] * int -> unit" Usage="roleProviderCollection.CopyTo (array, index)" />
<MemberSignature Language="C++ CLI" Value="public:
 void CopyTo(cli::array <System::Web::Security::RoleProvider ^> ^ array, int index);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="array" Type="System.Web.Security.RoleProvider[]" />
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="array">A one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Web.Security.RoleProviderCollection" />. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
<summary>Copies the role provider collection to a one-dimensional array.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method uses <xref:System.Collections.ArrayList.CopyTo%2A?displayProperty=nameWithType> to copy role provider objects to the specified array.
## Examples
The following code example uses the <xref:System.Web.Security.RoleProviderCollection.CopyTo%2A> method to copy the contents of a <xref:System.Web.Security.RoleProviderCollection> to an array of <xref:System.Web.Security.RoleProvider> objects.
[!code-csharp[System.Web.Security.RoleProviderCollection#3](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.RoleProviderCollection/CS/snippetscs.aspx#3)]
[!code-vb[System.Web.Security.RoleProviderCollection#3](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.RoleProviderCollection/VB/snippetsvb.aspx#3)]
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/5k850zwb(v=vs.100)">Understanding ASP.NET Role Management</related>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public System.Web.Security.RoleProvider this[string name] { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.Security.RoleProvider Item(string)" />
<MemberSignature Language="DocId" Value="P:System.Web.Security.RoleProviderCollection.Item(System.String)" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property Item(name As String) As RoleProvider" />
<MemberSignature Language="F#" Value="member this.Item(string) : System.Web.Security.RoleProvider" Usage="System.Web.Security.RoleProviderCollection.Item" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::Security::RoleProvider ^ default[System::String ^] { System::Web::Security::RoleProvider ^ get(System::String ^ name); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Security.RoleProvider</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name of the role provider.</param>
<summary>Gets the role provider in the collection referenced by the specified provider name.</summary>
<value>An object that inherits the <see cref="T:System.Web.Security.RoleProvider" /> abstract class.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The role providers for an application are exposed as a read-only <xref:System.Web.Security.RoleProviderCollection> by the <xref:System.Web.Security.Roles.Providers%2A> property of the <xref:System.Web.Security.Roles> class. You can access a specific role provider in the collection by name and cast it as the specific provider type, such as <xref:System.Web.Security.SqlRoleProvider>. This enables you to manage role information from multiple data stores in a single application as well as access custom members of a role provider that are not part of the <xref:System.Web.Security.RoleProvider> abstract class.
## Examples
The following code example accesses a <xref:System.Web.Security.SqlRoleProvider> configured for an application from the <xref:System.Web.Security.Roles.Providers%2A> property of the <xref:System.Web.Security.Roles> class by name.
[!code-csharp[System.Web.Security.RoleProviderCollection#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.RoleProviderCollection/CS/snippetscs.aspx#2)]
[!code-vb[System.Web.Security.RoleProviderCollection#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.RoleProviderCollection/VB/snippetsvb.aspx#2)]
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/5k850zwb(v=vs.100)">Understanding ASP.NET Role Management</related>
</Docs>
</Member>
</Members>
</Type>