CookieContainer.GetCookieHeader(Uri) Method

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.Primitives.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: CookieContainer.cs

Source:: CookieContainer.cs

Source:: CookieContainer.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 System::String ^ GetCookieHeader(Uri ^ uri);

public string GetCookieHeader (Uri uri);

member this.GetCookieHeader : Uri -> string

Public Function GetCookieHeader (uri As Uri) As String

Parameters

uri: Uri

The URI of the Cookie instances desired.

Returns

String

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

Exceptions

ArgumentNullException

uri is null.

Remarks

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.

Applies to