CookieHandler.WriteCore Method

[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.]

When overridden in a derived class, writes a cookie.

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

Usage

'Usage
Dim value As Byte()
Dim name As String
Dim path As String
Dim domain As String
Dim expirationTime As DateTime
Dim secure As Boolean
Dim httpOnly As Boolean
Dim context As HttpContext

Me.WriteCore(value, name, path, domain, expirationTime, secure, httpOnly, context)

Syntax

'Declaration
Protected MustOverride Sub WriteCore ( _
    value As Byte(), _
    name As String, _
    path As String, _
    domain As String, _
    expirationTime As DateTime, _
    secure As Boolean, _
    httpOnly As Boolean, _
    context As HttpContext _
)
protected abstract void WriteCore (
    byte[] value,
    string name,
    string path,
    string domain,
    DateTime expirationTime,
    bool secure,
    bool httpOnly,
    HttpContext context
)
protected:
virtual void WriteCore (
    array<unsigned char>^ value, 
    String^ name, 
    String^ path, 
    String^ domain, 
    DateTime expirationTime, 
    bool secure, 
    bool httpOnly, 
    HttpContext^ context
) abstract
protected abstract void WriteCore (
    byte[] value, 
    String name, 
    String path, 
    String domain, 
    DateTime expirationTime, 
    boolean secure, 
    boolean httpOnly, 
    HttpContext context
)
protected abstract function WriteCore (
    value : byte[], 
    name : String, 
    path : String, 
    domain : String, 
    expirationTime : DateTime, 
    secure : boolean, 
    httpOnly : boolean, 
    context : HttpContext
)

Parameters

  • value
    Value for the cookie
  • name
    Name for the cookie
  • path
    Path for the cookie
  • domain
    Domain for the cookie
  • expirationTime
    Expiration time for the cookie, or MinValue for a session cookie
  • secure
    a value that specifies if it is required to transmit the cookie over an SSL connection (HTTPS); otherwise, false.
  • httpOnly
    a value that specifies whether a cookie is accessible by client-side.

Remarks

Called from the Write method to do the actual work of writing the cookie. The Write method will ensure that value is a non-empty byte array and that name and path are non-empty strings.

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

CookieHandler Class
CookieHandler Members
Microsoft.IdentityModel.Web Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.