FormsAuthenticationConfiguration.Name Property

Definition

Namespace:

System.Web.Configuration

Assembly:

System.Web.dll

Gets or sets the cookie name.

public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };

[System.Configuration.ConfigurationProperty("name", DefaultValue=".ASPXAUTH")]
[System.Configuration.StringValidator(MinLength=1)]
public string Name { get; set; }

[<System.Configuration.ConfigurationProperty("name", DefaultValue=".ASPXAUTH")>]
[<System.Configuration.StringValidator(MinLength=1)>]
member this.Name : string with get, set

Public Property Name As String

Property Value

String

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

Attributes

ConfigurationPropertyAttribute StringValidatorAttribute

Examples

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;

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


    ' Get the authentication section.
    Dim authenticationSection As AuthenticationSection = _
        CType(configuration.GetSection("system.web/authentication"), AuthenticationSection)


    ' Get the external Forms section .
    Dim formsAuthentication As FormsAuthenticationConfiguration = _
        authenticationSection.Forms

    Dim cookieName As String = formsAuthentication.Name