CookieHandlerElement.Mode Property

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Gets or sets the cookie handler mode.

Namespace: Microsoft.IdentityModel.Web.Configuration
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As CookieHandlerElement
Dim value As CookieHandlerMode

value = instance.Mode

instance.Mode = value

Syntax

'Declaration
<ConfigurationPropertyAttribute("mode", IsRequired:=False, DefaultValue:=CookieHandlerMode.Default)> _
Public Property Mode As CookieHandlerMode

[ConfigurationPropertyAttribute("mode", IsRequired=false, DefaultValue=CookieHandlerMode.Default)] 
public CookieHandlerMode Mode { get; set; }

[ConfigurationPropertyAttribute(L"mode", IsRequired=false, DefaultValue=CookieHandlerMode::Default)] 
public:
property CookieHandlerMode Mode {
    CookieHandlerMode get ();
    void set (CookieHandlerMode value);
}

/** @property */
public CookieHandlerMode get_Mode ()

/** @property */
public void set_Mode (CookieHandlerMode value)

public function get Mode () : CookieHandlerMode

public function set Mode (value : CookieHandlerMode)

Property Value

A valid CookieHandlerMode value that indicates the kind of cookie handler that is being configured. The default value is Default, which indicates a chunked cookie handler.

Remarks

For chunked cookie handlers (the ChunkedCookieHandler property is set), the mode should be set to either Chunked or Default. For a custom cookie handler (the CustomCookieHandler property is set), the mode should be set to Custom.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)