This documentation is archived and is not being maintained.

CookieContainer.GetCookieHeader Method

Gets the HTTP cookie header that contains the HTTP cookies that represent the Cookie instances that are associated with a specific URI.

Namespace: System.Net
Assembly: System (in system.dll)

public:
String^ GetCookieHeader (
	Uri^ uri
)
public String GetCookieHeader (
	Uri uri
)
public function GetCookieHeader (
	uri : Uri
) : String
Not applicable.

Parameters

uri

The URI of the Cookie instances desired.

Return Value

An HTTP cookie header, with strings representing Cookie instances delimited by semicolons.

Exception typeCondition

ArgumentNullException

uri is a null reference (Nothing in Visual Basic).

GetCookieHeader returns a string that holds the HTTP cookie header for the Cookie instances specified by uri. The HTTP header is built by adding a string representation of each Cookie associated with uri. Note that the exact format of the string depends on the RFC that the Cookie conforms to. The strings for all the Cookie instances that are associated with uri are combined and delimited by semicolons.

This string is not in the correct format for use as the second parameter of the SetCookies method.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: