Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetCookieHeader Method
Collapse the table of content
Expand the table of content

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)

'Declaration
Public Function GetCookieHeader ( _
	uri As Uri _
) As String
'Usage
Dim instance As CookieContainer 
Dim uri As Uri 
Dim returnValue As String 

returnValue = instance.GetCookieHeader(uri)

Parameters

uri
Type: System.Uri

The URI of the Cookie instances desired.

Return Value

Type: System.String
An HTTP cookie header, with strings representing Cookie instances delimited by semicolons.

ExceptionCondition
ArgumentNullException

uri is Nothing.

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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

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

Community Additions

ADD
Show:
© 2015 Microsoft