IClientFormsAuthenticationCredentialsProvider.xml

<Type Name="IClientFormsAuthenticationCredentialsProvider" FullName="System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider">
  <TypeSignature Language="C#" Value="public interface IClientFormsAuthenticationCredentialsProvider" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IClientFormsAuthenticationCredentialsProvider" />
  <TypeSignature Language="DocId" Value="T:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider" />
  <TypeSignature Language="VB.NET" Value="Public Interface IClientFormsAuthenticationCredentialsProvider" />
  <TypeSignature Language="F#" Value="type IClientFormsAuthenticationCredentialsProvider = interface" />
  <TypeSignature Language="C++ CLI" Value="public interface class IClientFormsAuthenticationCredentialsProvider" />
  <AssemblyInfo>
    <AssemblyName>System.Web.Extensions</AssemblyName>
    <AssemblyVersion>3.5.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Docs>
    <summary>Defines a method that the <see cref="T:System.Web.ClientServices.Providers.ClientFormsAuthenticationMembershipProvider" /> class calls to retrieve user credentials.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 When using forms authentication with client application services, you can pass a user name and password to the <xref:System.Web.Security.Membership.ValidateUser%2A> method. You can also pass empty strings or `null` as the parameters to use a credentials provider. A credentials provider is a class that you provide and specify in your application configuration. A credentials provider class must implement the <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider> interface, which has a single method named <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider.GetCredentials%2A>. A typical <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider.GetCredentials%2A> method implementation will display a dialog box to retrieve user input. Using a credentials provider enables you to share a single login dialog box among multiple applications.

## Examples  
 The following example code demonstrates how to implement the <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider.GetCredentials%2A> method, which is the only member in this interface. In this example, the <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider.GetCredentials%2A> method is part of a login dialog box class. This method displays the dialog box, and then returns a <xref:System.Web.ClientServices.Providers.ClientFormsAuthenticationCredentials> instance initialized with the user-specified values.  
  
 :::code language="csharp" source="~/snippets/csharp/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.cs" id="Snippet210":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/ClientApplicationServices/VB/Login.vb" id="Snippet210":::  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.Web.ClientServices.Providers.ClientFormsAuthenticationMembershipProvider" />
    <altmember cref="M:System.Web.Security.Membership.ValidateUser(System.String,System.String)" />
    <altmember cref="T:System.Web.ClientServices.Providers.ClientFormsAuthenticationCredentials" />
    <related type="Article" href="https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2010/bb384297(v=vs.100)">Client Application Services</related>
    <related type="Article" href="https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2010/bb384312(v=vs.100)">How to: Configure Client Application Services</related>
    <related type="Article" href="https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2010/bb384313(v=vs.100)">How to: Implement User Login and Logout with Client Application Services</related>
  </Docs>
  <Members>
    <Member MemberName="GetCredentials">
      <MemberSignature Language="C#" Value="public System.Web.ClientServices.Providers.ClientFormsAuthenticationCredentials GetCredentials ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Web.ClientServices.Providers.ClientFormsAuthenticationCredentials GetCredentials() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider.GetCredentials" />
      <MemberSignature Language="VB.NET" Value="Public Function GetCredentials () As ClientFormsAuthenticationCredentials" />
      <MemberSignature Language="F#" Value="abstract member GetCredentials : unit -&gt; System.Web.ClientServices.Providers.ClientFormsAuthenticationCredentials" Usage="iClientFormsAuthenticationCredentialsProvider.GetCredentials " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Web::ClientServices::Providers::ClientFormsAuthenticationCredentials ^ GetCredentials();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Extensions</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.ClientServices.Providers.ClientFormsAuthenticationCredentials</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Retrieves user credentials.</summary>
        <returns>The user login information.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 When using forms authentication with client application services, you can pass a user name and password to the <xref:System.Web.Security.Membership.ValidateUser%2A> method. You can also pass empty strings or `null` as the parameters to use a credentials provider. A credentials provider is a class that you provide and specify in your application configuration. A credentials provider class must implement the <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider> interface, which has a single method called <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider.GetCredentials%2A>. A typical <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider.GetCredentials%2A> method implementation will display a dialog box to retrieve user input. Using a credentials provider enables you to share a single login dialog box among multiple applications.

## Examples  
 The following example code demonstrates how to implement the <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider.GetCredentials%2A> method. In this example, the <xref:System.Web.ClientServices.Providers.IClientFormsAuthenticationCredentialsProvider.GetCredentials%2A> method is part of a login dialog box class. This method displays the dialog box, and then returns a <xref:System.Web.ClientServices.Providers.ClientFormsAuthenticationCredentials> instance initialized with the user-specified values.  
  
 :::code language="csharp" source="~/snippets/csharp/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.cs" id="Snippet210":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/ClientApplicationServices/VB/Login.vb" id="Snippet210":::  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Web.ClientServices.Providers.ClientFormsAuthenticationMembershipProvider" />
        <altmember cref="M:System.Web.Security.Membership.ValidateUser(System.String,System.String)" />
        <altmember cref="T:System.Web.ClientServices.Providers.ClientFormsAuthenticationCredentials" />
        <related type="Article" href="https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2010/bb384297(v=vs.100)">Client Application Services</related>
        <related type="Article" href="https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2010/bb384312(v=vs.100)">How to: Configure Client Application Services</related>
        <related type="Article" href="https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2010/bb384313(v=vs.100)">How to: Implement User Login and Logout with Client Application Services</related>
      </Docs>
    </Member>
  </Members>
</Type>