FormsAuthenticationConfiguration.Name Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the cookie name.

Namespace:   System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

[ConfigurationPropertyAttribute("name", DefaultValue = ".ASPXAUTH")]
[StringValidatorAttribute(MinLength = 1)]
public string Name { get; set; }

Property Value

Type: System.String

The name of the HTTP cookie to use for request authentication.

The following code example shows how to access the Name property Refer to the code example in the FormsAuthenticationConfiguration class topic to learn how to get the section.

// Get the configuration file. Replace the name configTarget
// with the name of your site.
System.Configuration.Configuration configuration =
    WebConfigurationManager.OpenWebConfiguration("/configTarget");


// Get the external Authentication section.
AuthenticationSection authenticationSection =
    (AuthenticationSection)configuration.GetSection(
    "system.web/authentication");

// Get the external Forms section .
FormsAuthenticationConfiguration formsAuthentication =
  authenticationSection.Forms;

string cookieName = formsAuthentication.Name;

.NET Framework
Available since 2.0
Return to top
Show: