Windows Dev Center

CookieContainer Class

Provides a container for a collection of CookieCollection objects.

System.Object
  System.Net.CookieContainer

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

public class CookieContainer

The CookieContainer type exposes the following members.

  NameDescription
Public methodCookieContainerInitializes a new instance of the CookieContainer class.
Top

  NameDescription
Public propertyCapacityGets the number of Cookie objects this CookieContainer can contain.
Public propertyCountGets the number of Cookie objects this CookieContainer contains.
Public propertyMaxCookieSizeGets the maximum cookie length for cookies in the CookieContainer.
Public propertyPerDomainCapacityGets the number of Cookie instances that a CookieContainer can hold per domain.
Top

  NameDescription
Public methodAdd(Uri, Cookie)Adds the specified Cookie with the specified Uniform Resource Identifier (URI) to this CookieContainer.
Public methodAdd(Uri, CookieCollection)Adds the contents of the specified CookieCollection with the specified Uniform Resource Identifier (URI) to this CookieContainer.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetCookieHeaderGets the HTTP cookie header that contains cookies pertaining to the specified Uniform Resource Identifier (URI).
Public methodGetCookiesGets the CookieCollection associated with the specified Uniform Resource Identifier (URI).
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSetCookiesCreates cookie instances for the cookies specified in the HTTP cookie header and adds them to the CookieContainer associated with the specified Uniform Resource Identifier (URI).
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberDefaultCookieLengthLimitRepresents the default maximum size, in bytes, of the Cookie objects that the CookieContainer can hold. This field is constant.
Public fieldStatic memberDefaultCookieLimitRepresents the default maximum number of Cookie objects that the CookieContainer can hold. This field is constant.
Public fieldStatic memberDefaultPerDomainCookieLimitRepresents the default maximum number of Cookie objects that the CookieContainer can reference per domain. This field is constant.
Top

A CookieContainer provides storage for CookieCollection objects on HttpWebRequest objects through the HttpWebRequest.CookieContainer property. The CookieContainer creates an internal CookieCollection to store cookies associated with a particular Uniform Resource Identifier (URI). A Cookie is retrieved from the container based on its URI as a CookieCollection, or as a string that can be used to submit with HTTP requests.

You must always create a CookieContainer to send with a request if you want cookies to be returned on the response. This is also true for HTTPOnly cookies, which you cannot retrieve.

The CookieContainer has three properties that specify the volume of the content of the container: Capacity, MaxCookieSize, and PerDomainCapacity. These properties have the default values of 300, 4096, and 20 respectively. When a Cookie is added to the container, these properties are used to determine whether a Cookie is already contained in the CookieContainer and whether one or more Cookie objects should be discarded to make room for the new one. The CookieContainer keeps track of each addition to make sure that neither the CookieContainer nor the PerDomainCapacity limits are exceeded. If one or both are exceeded, then Cookie instances held by the CookieContainer are removed. First, any expired Cookie is removed. If additional capacity must be recaptured, then the least-recently-used CookieCollection is purged. If you attempt to add a cookie that already exists, that cookie will be overwritten.

Capabilities

If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.

ID_CAP_NETWORKING

Windows Phone 8, Windows Phone OS 7.1

For more info, see App capabilities and hardware requirements for Windows Phone 8.

The following example shows how to use the Add method.


request.CookieContainer.Add(new Uri("http://windowsteamblog.com/windows_phone/b/windowsphone/rss.aspx"),
    new Cookie("id", "1234"));


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2015 Microsoft