Asposecpplib
System::Net::CookieContainer Class Reference

Provides a container for the CookieCollection-class instances. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Object.

Public Member Functions

int32_t get_Capacity ()
 Gets the collection capacity. More...
 
void set_Capacity (int32_t value)
 Sets the collection capacity. More...
 
int32_t get_Count ()
 Returns the number of the collection's items. More...
 
int32_t get_MaxCookieSize ()
 Gets the maximum cookie size. More...
 
void set_MaxCookieSize (int32_t value)
 Sets the maximum cookie size. More...
 
int32_t get_PerDomainCapacity ()
 Gets the collection capacity per domain. More...
 
void set_PerDomainCapacity (int32_t value)
 Sets the collection capacity per domain. More...
 
 CookieContainer ()
 Constructs a new instance. More...
 
 CookieContainer (int32_t capacity)
 Constructs a new instance. More...
 
 CookieContainer (int32_t capacity, int32_t perDomainCapacity, int32_t maxCookieSize)
 Constructs a new instance. More...
 
void Add (System::SharedPtr< Cookie > cookie)
 Adds a cookie to the collection. More...
 
void Add (System::SharedPtr< Cookie > cookie, bool throwOnError)
 Adds a cookie to the collection. More...
 
void Add (System::SharedPtr< CookieCollection > cookies)
 Copies cookies from the specified collection to the current one. More...
 
bool IsLocalDomain (String host)
 Checks if the specified domain is localhost. More...
 
void Add (System::SharedPtr< Uri > uri, System::SharedPtr< Cookie > cookie)
 Adds a cookie for the specified URI. More...
 
void Add (System::SharedPtr< Uri > uri, System::SharedPtr< CookieCollection > cookies)
 Copies cookies from the specified collection for the specified URI to the current collection. More...
 
System::SharedPtr< CookieCollectionCookieCutter (System::SharedPtr< Uri > uri, String headerName, String setCookieHeader, bool isThrow)
 Copies cookies from the specified HTTP header for the specified URI. More...
 
System::SharedPtr< CookieCollectionGetCookies (System::SharedPtr< Uri > uri)
 Returns a collection of cookies that are associated with the specified URI. More...
 
System::SharedPtr< CookieCollectionInternalGetCookies (System::SharedPtr< Uri > uri)
 Returns a collection of cookies that are associated with the specified URI. More...
 
String GetCookieHeader (System::SharedPtr< Uri > uri)
 Return an HTTP header that contains cookies associated with the specified URI. More...
 
String GetCookieHeader (System::SharedPtr< Uri > uri, String &optCookie2)
 Return an HTTP header that contains cookies associated with the specified URI. More...
 
void SetCookies (System::SharedPtr< Uri > uri, String cookieHeader)
 Copies cookies from the specified header to the collection and associates them with the specified URI. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Static Public Attributes

static const int32_t DefaultCookieLimit
 The maximum number of collection items. More...
 
static const int32_t DefaultPerDomainCookieLimit
 The maximum number of collection items per domain. More...
 
static const int32_t DefaultCookieLengthLimit
 The maximum cookie size. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Provides a container for the CookieCollection-class instances. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ CookieContainer() [1/3]

System::Net::CookieContainer::CookieContainer ( )

Constructs a new instance.

◆ CookieContainer() [2/3]

System::Net::CookieContainer::CookieContainer ( int32_t  capacity)

Constructs a new instance.

Parameters
capacityThe collection capacity.

◆ CookieContainer() [3/3]

System::Net::CookieContainer::CookieContainer ( int32_t  capacity,
int32_t  perDomainCapacity,
int32_t  maxCookieSize 
)

Constructs a new instance.

Parameters
capacityThe collection capacity.
perDomainCapacityThe collection capacity per domain.
maxCookieSizeThe maximum cookie size.

Member Function Documentation

◆ Add() [1/5]

void System::Net::CookieContainer::Add ( System::SharedPtr< Cookie cookie)

Adds a cookie to the collection.

Parameters
cookieThe cookie to add.

◆ Add() [2/5]

void System::Net::CookieContainer::Add ( System::SharedPtr< Cookie cookie,
bool  throwOnError 
)

Adds a cookie to the collection.

Parameters
cookieThe cookie to add.
throwOnErrorA value that indicates if an exception will be thrown when an error occurs.

◆ Add() [3/5]

void System::Net::CookieContainer::Add ( System::SharedPtr< CookieCollection cookies)

Copies cookies from the specified collection to the current one.

Parameters
cookiesThe collection from which cookies will be copied.

◆ Add() [4/5]

void System::Net::CookieContainer::Add ( System::SharedPtr< Uri uri,
System::SharedPtr< Cookie cookie 
)

Adds a cookie for the specified URI.

Parameters
uriAn URI of the cookie.
cookieThe cookie to add.

◆ Add() [5/5]

void System::Net::CookieContainer::Add ( System::SharedPtr< Uri uri,
System::SharedPtr< CookieCollection cookies 
)

Copies cookies from the specified collection for the specified URI to the current collection.

Parameters
uriAn URI of the cookie.
cookiesA cookie collection from which cookies must be copied.

◆ CookieCutter()

System::SharedPtr<CookieCollection> System::Net::CookieContainer::CookieCutter ( System::SharedPtr< Uri uri,
String  headerName,
String  setCookieHeader,
bool  isThrow 
)

Copies cookies from the specified HTTP header for the specified URI.

◆ get_Capacity()

int32_t System::Net::CookieContainer::get_Capacity ( )

Gets the collection capacity.

Returns
The collection capacity.

◆ get_Count()

int32_t System::Net::CookieContainer::get_Count ( )

Returns the number of the collection's items.

Returns
The number of the collection's items.

◆ get_MaxCookieSize()

int32_t System::Net::CookieContainer::get_MaxCookieSize ( )

Gets the maximum cookie size.

Returns
The maximum cookie size.
Remarks
A new cookie will be truncated when its size exceeds the maximum cookie size.

◆ get_PerDomainCapacity()

int32_t System::Net::CookieContainer::get_PerDomainCapacity ( )

Gets the collection capacity per domain.

Returns
The collection capacity per domain.

◆ GetCookieHeader() [1/2]

String System::Net::CookieContainer::GetCookieHeader ( System::SharedPtr< Uri uri)

Return an HTTP header that contains cookies associated with the specified URI.

Parameters
uriAn URI for which header name will be built.
Returns
An HTTP header that contains cookies associated with the specified URI.

◆ GetCookieHeader() [2/2]

String System::Net::CookieContainer::GetCookieHeader ( System::SharedPtr< Uri uri,
String optCookie2 
)

Return an HTTP header that contains cookies associated with the specified URI.

Parameters
uriAn URI for which header name will be built.
optCookie2The output parameter where a cookie with the maximum supported version will be assigned.
Returns
An HTTP header that contains cookies associated with the specified URI.

◆ GetCookies()

System::SharedPtr<CookieCollection> System::Net::CookieContainer::GetCookies ( System::SharedPtr< Uri uri)

Returns a collection of cookies that are associated with the specified URI.

Parameters
uriThe URI for which cookies will be searched.
Returns
A collection of cookies that are associated with the specified URI.

◆ InternalGetCookies()

System::SharedPtr<CookieCollection> System::Net::CookieContainer::InternalGetCookies ( System::SharedPtr< Uri uri)

Returns a collection of cookies that are associated with the specified URI.

Parameters
uriAn URI for which cookies will be searched.
Returns
A collection of cookies that are associated with the specified URI.

◆ IsLocalDomain()

bool System::Net::CookieContainer::IsLocalDomain ( String  host)

Checks if the specified domain is localhost.

Parameters
hostThe domain to check.
Returns
True when the specified domain is localhost, otherwise false.

◆ set_Capacity()

void System::Net::CookieContainer::set_Capacity ( int32_t  value)

Sets the collection capacity.

Parameters
valueThe value that must be set.

◆ set_MaxCookieSize()

void System::Net::CookieContainer::set_MaxCookieSize ( int32_t  value)

Sets the maximum cookie size.

Parameters
valueThe value that must be set.
Remarks
A new cookie will be truncated when its size exceeds the maximum cookie size.

◆ set_PerDomainCapacity()

void System::Net::CookieContainer::set_PerDomainCapacity ( int32_t  value)

Sets the collection capacity per domain.

Parameters
valueThe value that must be set.

◆ SetCookies()

void System::Net::CookieContainer::SetCookies ( System::SharedPtr< Uri uri,
String  cookieHeader 
)

Copies cookies from the specified header to the collection and associates them with the specified URI.

Parameters
uriThe URI.
cookieHeaderThe header that contains cookies.

Member Data Documentation

◆ DefaultCookieLengthLimit

const int32_t System::Net::CookieContainer::DefaultCookieLengthLimit
static

The maximum cookie size.

◆ DefaultCookieLimit

const int32_t System::Net::CookieContainer::DefaultCookieLimit
static

The maximum number of collection items.

◆ DefaultPerDomainCookieLimit

const int32_t System::Net::CookieContainer::DefaultPerDomainCookieLimit
static

The maximum number of collection items per domain.