GetCredentials Method
Collapse the table of content
Expand the table of content

IClientFormsAuthenticationCredentialsProvider.GetCredentials Method ()


Retrieves user credentials.

Namespace:   System.Web.ClientServices.Providers
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

ClientFormsAuthenticationCredentials GetCredentials()

When using forms authentication with client application services, you can pass a user name and password to the ValidateUser 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 IClientFormsAuthenticationCredentialsProvider interface, which has a single method called GetCredentials. A typical GetCredentials 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. For more information, see How to: Implement User Login with Client Application Services.

The following example code demonstrates how to implement the GetCredentials method. In this example, the GetCredentials method is part of a login dialog box class. This method displays the dialog box, and then returns a ClientFormsAuthenticationCredentials instance initialized with the user-specified values.

public ClientFormsAuthenticationCredentials GetCredentials()
    if (this.ShowDialog() == DialogResult.OK)
        return new ClientFormsAuthenticationCredentials(
            usernameTextBox.Text, passwordTextBox.Text,
        return null;

.NET Framework
Available since 3.5
Return to top
© 2015 Microsoft