/
ProfileInfo.xml
277 lines (260 loc) · 18.5 KB
/
ProfileInfo.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
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
<Type Name="ProfileInfo" FullName="System.Web.Profile.ProfileInfo">
<TypeSignature Language="C#" Value="public class ProfileInfo" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit ProfileInfo extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Web.Profile.ProfileInfo" />
<TypeSignature Language="VB.NET" Value="Public Class ProfileInfo" />
<TypeSignature Language="F#" Value="type ProfileInfo = class" />
<TypeSignature Language="C++ CLI" Value="public ref class ProfileInfo" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Serializable]</AttributeName>
<AttributeName Language="F#">[<System.Serializable>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides information about a user profile.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Profile.ProfileInfo> class is used to represent information about a user profile from the data store, including the last date and time when profile properties were retrieved or updated, the user name associated with the profile, and whether the profile is for an anonymous or authenticated user.
<xref:System.Web.Profile.ProfileInfo> objects are constructed and returned as part of a <xref:System.Web.Profile.ProfileInfoCollection> by the <xref:System.Web.Profile.ProfileProvider.GetAllProfiles%2A>, <xref:System.Web.Profile.ProfileProvider.GetAllInactiveProfiles%2A>, <xref:System.Web.Profile.ProfileProvider.FindProfilesByUserName%2A>, and <xref:System.Web.Profile.ProfileProvider.FindInactiveProfilesByUserName%2A> methods of a <xref:System.Web.Profile.ProfileProvider>.
## Examples
For an example of a <xref:System.Web.Profile.ProfileProvider> implementation that creates a <xref:System.Web.Profile.ProfileInfoCollection> of <xref:System.Web.Profile.ProfileInfo> objects for user profiles in a data store, see [Implementing a Profile Provider](https://docs.microsoft.com/previous-versions/aspnet/0580x1f5(v=vs.100)).
]]></format>
</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/0580x1f5(v=vs.100)">Implementing a Profile Provider</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)">ASP.NET Profile Properties Overview</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Creates an instance of the <see cref="T:System.Web.Profile.ProfileInfo" /> class.</summary>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)">ASP.NET Profile Properties Overview</related>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ProfileInfo ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Profile.ProfileInfo.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 ProfileInfo();" />
<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 an instance of the <see cref="T:System.Web.Profile.ProfileInfo" /> object for a class that inherits the <see cref="T:System.Web.Profile.ProfileInfo" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This <xref:System.Web.Profile.ProfileInfo?displayProperty=nameWithType> constructor is not intended to be used from your code. Instead, use the <xref:System.Web.Profile.ProfileInfo.%23ctor%2A?displayProperty=nameWithType>.
<xref:System.Web.Profile.ProfileInfo> objects are constructed and returned as part of a <xref:System.Web.Profile.ProfileInfoCollection> by the <xref:System.Web.Profile.ProfileProvider.GetAllProfiles%2A>, <xref:System.Web.Profile.ProfileProvider.GetAllInactiveProfiles%2A>, <xref:System.Web.Profile.ProfileProvider.FindProfilesByUserName%2A>, and <xref:System.Web.Profile.ProfileProvider.FindInactiveProfilesByUserName%2A> methods of a <xref:System.Web.Profile.ProfileProvider>.
]]></format>
</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)">ASP.NET Profile Properties Overview</related>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProfileInfo (string username, bool isAnonymous, DateTime lastActivityDate, DateTime lastUpdatedDate, int size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string username, bool isAnonymous, valuetype System.DateTime lastActivityDate, valuetype System.DateTime lastUpdatedDate, int32 size) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Profile.ProfileInfo.#ctor(System.String,System.Boolean,System.DateTime,System.DateTime,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (username As String, isAnonymous As Boolean, lastActivityDate As DateTime, lastUpdatedDate As DateTime, size As Integer)" />
<MemberSignature Language="F#" Value="new System.Web.Profile.ProfileInfo : string * bool * DateTime * DateTime * int -> System.Web.Profile.ProfileInfo" Usage="new System.Web.Profile.ProfileInfo (username, isAnonymous, lastActivityDate, lastUpdatedDate, size)" />
<MemberSignature Language="C++ CLI" Value="public:
 ProfileInfo(System::String ^ username, bool isAnonymous, DateTime lastActivityDate, DateTime lastUpdatedDate, int size);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="username" Type="System.String" />
<Parameter Name="isAnonymous" Type="System.Boolean" />
<Parameter Name="lastActivityDate" Type="System.DateTime" />
<Parameter Name="lastUpdatedDate" Type="System.DateTime" />
<Parameter Name="size" Type="System.Int32" />
</Parameters>
<Docs>
<param name="username">The user name for the profile.</param>
<param name="isAnonymous">
<see langword="true" /> to indicate the profile is for an anonymous user; <see langword="false" /> to indicate the profile is for an authenticated user.</param>
<param name="lastActivityDate">The last date and time when the profile was read or updated.</param>
<param name="lastUpdatedDate">The last date and time when the profile was updated.</param>
<param name="size">The size of the profile information and values stored in the data source.</param>
<summary>Creates an instance of the <see cref="T:System.Web.Profile.ProfileInfo" /> class with the specified property values.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Profile.ProfileInfo> object is used to represent information about a user profile from the data store, including the last date and time when profile properties were retrieved or updated, the user name associated with the profile, and whether the profile is for an anonymous or authenticated user.
<xref:System.Web.Profile.ProfileInfo> objects are constructed and returned as a <xref:System.Web.Profile.ProfileInfoCollection> by the <xref:System.Web.Profile.ProfileProvider.GetAllProfiles%2A>, <xref:System.Web.Profile.ProfileProvider.GetAllInactiveProfiles%2A>, <xref:System.Web.Profile.ProfileProvider.FindProfilesByUserName%2A>, and <xref:System.Web.Profile.ProfileProvider.FindInactiveProfilesByUserName%2A> methods of a <xref:System.Web.Profile.ProfileProvider>.
## Examples
For an example of a <xref:System.Web.Profile.ProfileProvider> implementation that creates a <xref:System.Web.Profile.ProfileInfoCollection> of <xref:System.Web.Profile.ProfileInfo> objects for user profiles in a data store, see [Implementing a Profile Provider](https://docs.microsoft.com/previous-versions/aspnet/0580x1f5(v=vs.100)).
]]></format>
</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/0580x1f5(v=vs.100)">Implementing a Profile Provider</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)">ASP.NET Profile Properties Overview</related>
</Docs>
</Member>
<Member MemberName="IsAnonymous">
<MemberSignature Language="C#" Value="public virtual bool IsAnonymous { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsAnonymous" />
<MemberSignature Language="DocId" Value="P:System.Web.Profile.ProfileInfo.IsAnonymous" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property IsAnonymous As Boolean" />
<MemberSignature Language="F#" Value="member this.IsAnonymous : bool" Usage="System.Web.Profile.ProfileInfo.IsAnonymous" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool IsAnonymous { bool get(); };" />
<MemberType>Property</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#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets whether the user name for the profile is anonymous.</summary>
<value>
<see langword="true" /> if the user name for the profile is anonymous; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)">ASP.NET Profile Properties Overview</related>
</Docs>
</Member>
<Member MemberName="LastActivityDate">
<MemberSignature Language="C#" Value="public virtual DateTime LastActivityDate { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime LastActivityDate" />
<MemberSignature Language="DocId" Value="P:System.Web.Profile.ProfileInfo.LastActivityDate" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property LastActivityDate As DateTime" />
<MemberSignature Language="F#" Value="member this.LastActivityDate : DateTime" Usage="System.Web.Profile.ProfileInfo.LastActivityDate" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property DateTime LastActivityDate { DateTime get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the last date and time when the profile was read or updated.</summary>
<value>A <see cref="T:System.DateTime" /> that represents the last date and time when the profile was read or updated.</value>
<remarks>To be added.</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)">ASP.NET Profile Properties Overview</related>
</Docs>
</Member>
<Member MemberName="LastUpdatedDate">
<MemberSignature Language="C#" Value="public virtual DateTime LastUpdatedDate { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime LastUpdatedDate" />
<MemberSignature Language="DocId" Value="P:System.Web.Profile.ProfileInfo.LastUpdatedDate" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property LastUpdatedDate As DateTime" />
<MemberSignature Language="F#" Value="member this.LastUpdatedDate : DateTime" Usage="System.Web.Profile.ProfileInfo.LastUpdatedDate" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property DateTime LastUpdatedDate { DateTime get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the last date and time when the profile was updated.</summary>
<value>A <see cref="T:System.DateTime" /> that represents the last date and time when the profile was updated.</value>
<remarks>To be added.</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)">ASP.NET Profile Properties Overview</related>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public virtual int Size { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Size" />
<MemberSignature Language="DocId" Value="P:System.Web.Profile.ProfileInfo.Size" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Size As Integer" />
<MemberSignature Language="F#" Value="member this.Size : int" Usage="System.Web.Profile.ProfileInfo.Size" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property int Size { int get(); };" />
<MemberType>Property</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#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the size of the profile property names and values stored in the data source.</summary>
<value>The size of the profile property names and values stored in the data source.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Profile.SqlProfileProvider> calculates the size of the profile as the total size of the string and binary columns that store the profile property values and the column that stores the profile property names. The size of the columns is determined using the SQL Server DATALENGTH function.
]]></format>
</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)">ASP.NET Profile Properties Overview</related>
</Docs>
</Member>
<Member MemberName="UserName">
<MemberSignature Language="C#" Value="public virtual string UserName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UserName" />
<MemberSignature Language="DocId" Value="P:System.Web.Profile.ProfileInfo.UserName" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property UserName As String" />
<MemberSignature Language="F#" Value="member this.UserName : string" Usage="System.Web.Profile.ProfileInfo.UserName" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ UserName { System::String ^ get(); };" />
<MemberType>Property</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#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the user name for the profile.</summary>
<value>The user name for the profile.</value>
<remarks>To be added.</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)">ASP.NET Profile Properties Overview</related>
</Docs>
</Member>
</Members>
</Type>