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
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ProfileProvider" FullName="System.Web.Profile.ProfileProvider">
<TypeSignature Language="C#" Value="public abstract class ProfileProvider : System.Configuration.SettingsProvider" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.SettingsProvider</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>ASP.NET profiles offer persistent storage and retrieval of user-specific properties. Profile property values and information are stored in a data source in a manner determined by the <see cref="T:System.Web.Profile.ProfileProvider" /> implementation. You can use the profile providers that are included with the .NET Framework (represented by the classes that derive from the <see cref="T:System.Web.Profile.ProfileProvider" /> abstract class), or you can implement your own provider by creating a new class that derives from <see cref="T:System.Web.Profile.ProfileProvider" />.</para>
<para>There are two primary reasons for creating a custom profile provider.</para>
<list type="bullet">
<item>
<para>You need to store profile information in a data source that is not supported by the profile providers included with the .NET Framework, such as a FoxPro database, an Oracle database, or other data stores.</para>
</item>
<item>
<para>You need to manage profile information using a database schema that is different from the database schema used by the providers that ship with the .NET Framework. A common example of this would be user data that already exists in a SQL Server database for a company network or a Web site.</para>
</item>
</list>
<para>The <see cref="T:System.Web.Profile.ProfileProvider" /> abstract class inherits from the <see cref="T:System.Configuration.SettingsProvider" /> abstract class, which inherits from the <see cref="T:System.Configuration.Provider.ProviderBase" /> abstract class. Classes that implement <see cref="T:System.Web.Profile.ProfileProvider" /> must also implement the required members of the <see cref="T:System.Configuration.SettingsProvider" /> and <see cref="T:System.Configuration.Provider.ProviderBase" /> abstract classes. For more information about implementing a profile provider, see <format type="text/html"><a href="58de6e99-31a7-41b9-93ed-51b9b4a67e98">Implementing a Profile Provider</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the contract that ASP.NET implements to provide profile services using custom profile providers.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ProfileProvider ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You are not required to implement a constructor for a class that inherits the <see cref="T:System.Web.Profile.ProfileProvider" /> abstract class. Initialization values for a <see cref="T:System.Web.Profile.ProfileProvider" /> implementation are passed to the <see cref="M:System.Configuration.Provider.ProviderBase.Initialize(System.String,System.Collections.Specialized.NameValueCollection)" /> method implementation.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Profile.ProfileProvider" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DeleteInactiveProfiles">
<MemberSignature Language="C#" Value="public abstract int DeleteInactiveProfiles (System.Web.Profile.ProfileAuthenticationOption authenticationOption, DateTime userInactiveSinceDate);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authenticationOption" Type="System.Web.Profile.ProfileAuthenticationOption" />
<Parameter Name="userInactiveSinceDate" Type="System.DateTime" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Profile.ProfileProvider.DeleteInactiveProfiles(System.Web.Profile.ProfileAuthenticationOption,System.DateTime)" /> method is used to remove unused profile data from the data source. Only data for the applicationName specified in the configuration file is removed. The <paramref name="authenticationOption" /> parameter specifies whether only anonymous profiles, only authenticated profiles, or all profiles are searched. Profiles in which the <see cref="P:System.Web.Profile.ProfileInfo.LastActivityDate" /> occurs on or before the specified <paramref name="userInactiveSinceDate" /> parameter value are deleted.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, deletes all user-profile data for profiles in which the last activity date occurred before the specified date.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The number of profiles deleted from the data source.</para>
</returns>
<param name="authenticationOption">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Web.Profile.ProfileAuthenticationOption" /> values, specifying whether anonymous, authenticated, or both types of profiles are deleted.</param>
<param name="userInactiveSinceDate">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.DateTime" /> that identifies which user profiles are considered inactive. If the <see cref="P:System.Web.Profile.ProfileInfo.LastActivityDate" /> value of a user profile occurs on or before this date and time, the profile is considered inactive.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DeleteProfiles">
<MemberSignature Language="C#" Value="public abstract int DeleteProfiles (string[] usernames);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="usernames" Type="System.String[]" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Profile.ProfileProvider.DeleteProfiles(System.String[])" /> method deletes the profiles specified in the <paramref name="usernames" /> parameter. Only data for the applicationName specified in the configuration file is removed. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, deletes profile properties and information for profiles that match the supplied list of user names.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The number of profiles deleted from the data source.</para>
</returns>
<param name="usernames">
<attribution license="cc4" from="Microsoft" modified="false" />A string array of user names for profiles to be deleted.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DeleteProfiles">
<MemberSignature Language="C#" Value="public abstract int DeleteProfiles (System.Web.Profile.ProfileInfoCollection profiles);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="profiles" Type="System.Web.Profile.ProfileInfoCollection" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Profile.ProfileProvider.DeleteProfiles(System.Web.Profile.ProfileInfoCollection)" /> method deletes the profiles specified in the <paramref name="profiles" /> parameter. Only data for the applicationName specified in the configuration file is removed. </para>
<para>When implementing this method in a derived class, you can use the applicationName value and the <see cref="P:System.Web.Profile.ProfileInfo.UserName" /> property of each <see cref="T:System.Web.Profile.ProfileInfo" /> object in the supplied <see cref="T:System.Web.Profile.ProfileInfoCollection" /> to determine which profiles to delete from your data source.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, deletes profile properties and information for the supplied list of profiles.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The number of profiles deleted from the data source.</para>
</returns>
<param name="profiles">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.Profile.ProfileInfoCollection" /> of information about profiles that are to be deleted.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FindInactiveProfilesByUserName">
<MemberSignature Language="C#" Value="public abstract System.Web.Profile.ProfileInfoCollection FindInactiveProfilesByUserName (System.Web.Profile.ProfileAuthenticationOption authenticationOption, string usernameToMatch, DateTime userInactiveSinceDate, int pageIndex, int pageSize, out int totalRecords);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Profile.ProfileInfoCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authenticationOption" Type="System.Web.Profile.ProfileAuthenticationOption" />
<Parameter Name="usernameToMatch" Type="System.String" />
<Parameter Name="userInactiveSinceDate" Type="System.DateTime" />
<Parameter Name="pageIndex" Type="System.Int32" />
<Parameter Name="pageSize" Type="System.Int32" />
<Parameter Name="totalRecords" Type="System.Int32&" RefType="out" />
</Parameters>
<Docs>
<param name="authenticationOption">To be added.</param>
<param name="usernameToMatch">To be added.</param>
<param name="userInactiveSinceDate">To be added.</param>
<param name="pageIndex">To be added.</param>
<param name="pageSize">To be added.</param>
<param name="totalRecords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FindProfilesByUserName">
<MemberSignature Language="C#" Value="public abstract System.Web.Profile.ProfileInfoCollection FindProfilesByUserName (System.Web.Profile.ProfileAuthenticationOption authenticationOption, string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Profile.ProfileInfoCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authenticationOption" Type="System.Web.Profile.ProfileAuthenticationOption" />
<Parameter Name="usernameToMatch" Type="System.String" />
<Parameter Name="pageIndex" Type="System.Int32" />
<Parameter Name="pageSize" Type="System.Int32" />
<Parameter Name="totalRecords" Type="System.Int32&" RefType="out" />
</Parameters>
<Docs>
<param name="authenticationOption">To be added.</param>
<param name="usernameToMatch">To be added.</param>
<param name="pageIndex">To be added.</param>
<param name="pageSize">To be added.</param>
<param name="totalRecords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetAllInactiveProfiles">
<MemberSignature Language="C#" Value="public abstract System.Web.Profile.ProfileInfoCollection GetAllInactiveProfiles (System.Web.Profile.ProfileAuthenticationOption authenticationOption, DateTime userInactiveSinceDate, int pageIndex, int pageSize, out int totalRecords);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Profile.ProfileInfoCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authenticationOption" Type="System.Web.Profile.ProfileAuthenticationOption" />
<Parameter Name="userInactiveSinceDate" Type="System.DateTime" />
<Parameter Name="pageIndex" Type="System.Int32" />
<Parameter Name="pageSize" Type="System.Int32" />
<Parameter Name="totalRecords" Type="System.Int32&" RefType="out" />
</Parameters>
<Docs>
<param name="authenticationOption">To be added.</param>
<param name="userInactiveSinceDate">To be added.</param>
<param name="pageIndex">To be added.</param>
<param name="pageSize">To be added.</param>
<param name="totalRecords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetAllProfiles">
<MemberSignature Language="C#" Value="public abstract System.Web.Profile.ProfileInfoCollection GetAllProfiles (System.Web.Profile.ProfileAuthenticationOption authenticationOption, int pageIndex, int pageSize, out int totalRecords);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Profile.ProfileInfoCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authenticationOption" Type="System.Web.Profile.ProfileAuthenticationOption" />
<Parameter Name="pageIndex" Type="System.Int32" />
<Parameter Name="pageSize" Type="System.Int32" />
<Parameter Name="totalRecords" Type="System.Int32&" RefType="out" />
</Parameters>
<Docs>
<param name="authenticationOption">To be added.</param>
<param name="pageIndex">To be added.</param>
<param name="pageSize">To be added.</param>
<param name="totalRecords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetNumberOfInactiveProfiles">
<MemberSignature Language="C#" Value="public abstract int GetNumberOfInactiveProfiles (System.Web.Profile.ProfileAuthenticationOption authenticationOption, DateTime userInactiveSinceDate);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authenticationOption" Type="System.Web.Profile.ProfileAuthenticationOption" />
<Parameter Name="userInactiveSinceDate" Type="System.DateTime" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Profile.ProfileProvider.GetNumberOfInactiveProfiles(System.Web.Profile.ProfileAuthenticationOption,System.DateTime)" /> method is used to retrieve a count of all unused user profiles. Only data for the applicationName specified in the configuration file is returned. The <paramref name="authenticationOption" /> parameter specifies whether only anonymous profiles, only authenticated profiles, or all profiles are searched. Of the searched profiles, any profile with a <see cref="P:System.Web.Profile.ProfileInfo.LastActivityDate" /> that occurs on or before the specified <paramref name="userInactiveSinceDate" /> parameter value is counted.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, returns the number of profiles in which the last activity date occurred on or before the specified date.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The number of profiles in which the last activity date occurred on or before the specified date.</para>
</returns>
<param name="authenticationOption">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Web.Profile.ProfileAuthenticationOption" /> values, specifying whether anonymous, authenticated, or both types of profiles are returned.</param>
<param name="userInactiveSinceDate">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.DateTime" /> that identifies which user profiles are considered inactive. If the <see cref="P:System.Web.Profile.ProfileInfo.LastActivityDate" /> of a user profile occurs on or before this date and time, the profile is considered inactive.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
|