Compartilhar via


CookieHandlerElement.CustomCookieHandler Property

[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 a custom cookie handler type. This property must be set when a custom cookie handler is being configured.

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

Usage

'Usage
Dim instance As CookieHandlerElement
Dim value As CustomTypeElement

value = instance.CustomCookieHandler

instance.CustomCookieHandler = value

Syntax

'Declaration
<ConfigurationPropertyAttribute("customCookieHandler", IsRequired:=False)> _
Public Property CustomCookieHandler As CustomTypeElement
[ConfigurationPropertyAttribute("customCookieHandler", IsRequired=false)] 
public CustomTypeElement CustomCookieHandler { get; set; }
[ConfigurationPropertyAttribute(L"customCookieHandler", IsRequired=false)] 
public:
property CustomTypeElement^ CustomCookieHandler {
    CustomTypeElement^ get ();
    void set (CustomTypeElement^ value);
}
/** @property */
public CustomTypeElement get_CustomCookieHandler ()

/** @property */
public void set_CustomCookieHandler (CustomTypeElement value)
public function get CustomCookieHandler () : CustomTypeElement

public function set CustomCookieHandler (value : CustomTypeElement)

Property Value

A CustomTypeElement that defines the custom cookie handler type.

Remarks

This property is equivalent to the <customCookieHandler> element. It specifies a custom cookie handler type to use. If this property is set, the Mode property must be set to Custom. The custom type specified by this property must be derived from the CookieHandler class.

Either the ChunkedCookieHandler property or the CustomCookieHandler property may be set, but not both.

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)

See Also

Reference

CookieHandlerElement Class
CookieHandlerElement Members
Microsoft.IdentityModel.Web.Configuration Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.