CookieContainer.GetCookieHeader(Uri) Method

Definition

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

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

Exceptions

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

See also