CookieHandler.Write Method (Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)

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

Writes a cookie.

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

Usage

'Usage
Dim instance As CookieHandler
Dim value As Byte()
Dim name As String
Dim path As String
Dim domain As String
Dim expirationTime As DateTime
Dim requiresSsl As Boolean
Dim hideFromClientScript As Boolean
Dim context As HttpContext

instance.Write(value, name, path, domain, expirationTime, requiresSsl, hideFromClientScript, context)

Syntax

'Declaration
Public Sub Write ( _
    value As Byte(), _
    name As String, _
    path As String, _
    domain As String, _
    expirationTime As DateTime, _
    requiresSsl As Boolean, _
    hideFromClientScript As Boolean, _
    context As HttpContext _
)

public void Write (
    byte[] value,
    string name,
    string path,
    string domain,
    DateTime expirationTime,
    bool requiresSsl,
    bool hideFromClientScript,
    HttpContext context
)

public:
void Write (
    array<unsigned char>^ value, 
    String^ name, 
    String^ path, 
    String^ domain, 
    DateTime expirationTime, 
    bool requiresSsl, 
    bool hideFromClientScript, 
    HttpContext^ context
)

public void Write (
    byte[] value, 
    String name, 
    String path, 
    String domain, 
    DateTime expirationTime, 
    boolean requiresSsl, 
    boolean hideFromClientScript, 
    HttpContext context
)

public function Write (
    value : byte[], 
    name : String, 
    path : String, 
    domain : String, 
    expirationTime : DateTime, 
    requiresSsl : boolean, 
    hideFromClientScript : 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

requiresSsl
Value indicating whether the cookie should be sent over insecure connections.

hideFromClientScript
Value indicating whether the cookie should be hidden from client script.

context
HttpContext for the request

Exceptions

Exception type	Condition
ArgumentNullException	When name is null or empty -or- When value is null or empty

ArgumentNullException

When name is null or empty

-or-

When value is null or empty

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)

Share via