IClientFormsAuthenticationCredentialsProvider Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines a method that the ClientFormsAuthenticationMembershipProvider class calls to retrieve user credentials.
public interface class IClientFormsAuthenticationCredentialsProviderpublic interface IClientFormsAuthenticationCredentialsProvidertype IClientFormsAuthenticationCredentialsProvider = interfacePublic Interface IClientFormsAuthenticationCredentialsProviderExamples
The following example code demonstrates how to implement the GetCredentials method, which is the only member in this interface. 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,
rememberMeCheckBox.Checked);
}
else
{
return null;
}
}
Public Function GetCredentials() As _
ClientFormsAuthenticationCredentials Implements _
IClientFormsAuthenticationCredentialsProvider.GetCredentials
If Me.ShowDialog() = DialogResult.OK Then
Return New ClientFormsAuthenticationCredentials( _
UsernameTextBox.Text, PasswordTextBox.Text, _
rememberMeCheckBox.Checked)
Else
Return Nothing
End If
End Function
Remarks
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 named 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.
Methods
| GetCredentials() |
Retrieves user credentials. |
