CookieContainer Class
TOC
Collapse the table of content
Expand the table of content

CookieContainer Class

 

Provides a container for a collection of CookieCollection objects.

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

System::Object
  System.Net::CookieContainer

[SerializableAttribute]
public ref class CookieContainer 

NameDescription
System_CAPS_pubmethodCookieContainer()

Initializes a new instance of the CookieContainer class.

System_CAPS_pubmethodCookieContainer(Int32)

Initializes a new instance of the CookieContainer class with a specified value for the number of Cookie instances that the container can hold.

System_CAPS_pubmethodCookieContainer(Int32, Int32, Int32)

Initializes a new instance of the CookieContainer class with specific properties.

NameDescription
System_CAPS_pubpropertyCapacity

Gets and sets the number of Cookie instances that a CookieContainer can hold.

System_CAPS_pubpropertyCount

Gets the number of Cookie instances that a CookieContainer currently holds.

System_CAPS_pubpropertyMaxCookieSize

Represents the maximum allowed length of a Cookie.

System_CAPS_pubpropertyPerDomainCapacity

Gets and sets the number of Cookie instances that a CookieContainer can hold per domain.

NameDescription
System_CAPS_pubmethodAdd(Cookie^)

Adds a Cookie to a CookieContainer. This method uses the domain from the Cookie to determine which domain collection to associate the Cookie with.

System_CAPS_pubmethodAdd(CookieCollection^)

Adds the contents of a CookieCollection to the CookieContainer.

System_CAPS_pubmethodAdd(Uri^, Cookie^)

Adds a Cookie to the CookieContainer for a particular URI.

System_CAPS_pubmethodAdd(Uri^, CookieCollection^)

Adds the contents of a CookieCollection to the CookieContainer for a particular URI.

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetCookieHeader(Uri^)

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

System_CAPS_pubmethodGetCookies(Uri^)

Gets a CookieCollection that contains the Cookie instances that are associated with a specific URI.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodSetCookies(Uri^, String^)

Adds Cookie instances for one or more cookies from an HTTP cookie header to the CookieContainer for a specific URI.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDefaultCookieLengthLimit

Represents the default maximum size, in bytes, of the Cookie instances that the CookieContainer can hold. This field is constant.

System_CAPS_pubfieldSystem_CAPS_staticDefaultCookieLimit

Represents the default maximum number of Cookie instances that the CookieContainer can hold. This field is constant.

System_CAPS_pubfieldSystem_CAPS_staticDefaultPerDomainCookieLimit

Represents the default maximum number of Cookie instances that the CookieContainer can reference per domain. This field is constant.

A CookieContainer is a data structure that provides storage for instances of the Cookie class, and which is accessed in a database-like manner. The CookieContainer has a capacity limit that is set when the container is created or changed by a property.

An instance of the Cookie class is added to the container based on its originating URI. It is added to an internal CookieCollection associated with the URI. A Cookie is retrieved from the container based on the URI as a CookieCollection, or as a string that can be used to submit HTTP WebRequests.

The CookieContainer has three properties that govern the volume of the content of the container: Capacity, MaxCookieSize, and PerDomainCapacity. These values have the default settings of 300, 4096, and 20 respectively. When a Cookie is added to the container, these properties are used to determine whether a Cookie already contained in the CookieContainer should be discarded to make room for the new one. The CookieContainer keeps track of each addition to ensure that neither the Capacity 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 further capacity must be recaptured, then the least-recently used CookieCollection is purged.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 3.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

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

Return to top
Show:
© 2016 Microsoft